Add a member (creates the account + sends an invite if unknown)

POST /company/users

Scope users:admin
API key x-api-key
Base URL https://api.hub.akuasense.com/v1

E-mail already known: the account is attached to the company. Unknown: the account is created (name required), and an invitation goes out by e-mail with a link to choose a password. Restricted to an OWNER.

Headers

Idempotency-Key string

Replays the same 2xx response (24 h)

Request body

email string email required
name string

Name of the account to create. Required if the e-mail is unknown.
role string required

A member’s role within a company. OWNER and MANAGER can write, VIEWER only reads. Only an OWNER manages members (scope users:admin).

Values: OWNERMANAGERVIEWER

Response

201

Member added

userId string always present
email string email always present

Lowercased.
role string always present

A member’s role within a company. OWNER and MANAGER can write, VIEWER only reads. Only an OWNER manages members (scope users:admin).

Values: OWNERMANAGERVIEWER
invited boolean always present

true: account created just now, and an invitation sent by e-mail, with a link to choose a password. false: existing account, attached to the company.

Errors

400
Entry refused

invalid_body
401
Not authenticated
403
Insufficient scope/role, or outside your company
409
Already a member of the company

already_member

POST /company/users

curl -X POST https://api.hub.akuasense.com/v1/company/users \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "lucie.moreau@example.com",
    "name": "Lucie Moreau",
    "role": "VIEWER"
  }'

const response = await fetch(
  'https://api.hub.akuasense.com/v1/company/users',
  {
    method: 'POST',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "email": "lucie.moreau@example.com",
      "name": "Lucie Moreau",
      "role": "VIEWER"
    }),
  },
);
const data = await response.json();

import requests

response = requests.post(
    "https://api.hub.akuasense.com/v1/company/users",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={
        "email": "lucie.moreau@example.com",
        "name": "Lucie Moreau",
        "role": "VIEWER",
    },
)
data = response.json()

Response

{
  "userId": "cmf8x2k4q0003js08r6d1w5np",
  "email": "lucie.moreau@example.com",
  "role": "VIEWER",
  "invited": true
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 400,
  "detail": "string",
  "code": "invalid_body"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 409,
  "detail": "string",
  "code": "already_member"
}

application/problem+json · example generated from the schema