Upsert User

Create a user, or update the existing one matched by email, with pre-assigned information.

Users are matched by email and reused on first login (no duplicate). Returns 201 when a new user is created and 200 when an existing user is updated. is_staff cannot be set here.

POST /api/v1/users

Upsert User

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/users \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "organization_id": "<string>",
  "permission_ids": [
    "<string>"
  ],
  "additional_info": {},
  "business_context": {},
  "is_reviewer": true,
  "is_viewer": true
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/users"

payload = {
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "organization_id": "<string>",
    "permission_ids": ["<string>"],
    "additional_info": {},
    "business_context": {},
    "is_reviewer": True,
    "is_viewer": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    organization_id: '<string>',
    permission_ids: ['<string>'],
    additional_info: {},
    business_context: {},
    is_reviewer: true,
    is_viewer: true
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "<string>",
  "email": "<string>",
  "object": "user",
  "first_name": "",
  "last_name": "",
  "is_customer": true,
  "email_domain": "<string>",
  "organization": {},
  "created_at": "<string>",
  "permissions": [
    {
      "id": "<string>",
      "name": "<string>",
      "display_name": "<string>"
    }
  ]
}

{
  "id": "<string>",
  "email": "<string>",
  "object": "user",
  "first_name": "",
  "last_name": "",
  "is_customer": true,
  "email_domain": "<string>",
  "organization": {},
  "created_at": "<string>",
  "permissions": [
    {
      "id": "<string>",
      "name": "<string>",
      "display_name": "<string>"
    }
  ]
}

Authorizations

X-API-Key · string · header · required

Body

application/json

Create a user, or update the existing one matched by email, before first login.

Only provided fields are written. is_staff is intentionally not exposed: the API can never grant admin (staff) status.

email · string · required

first_name · string | null

last_name · string | null

organization_id · string | null

permission_ids · string[] | null

additional_info · Additional Info · object | null

business_context · Business Context · object | null

is_reviewer · boolean | null

is_viewer · boolean | null

Response

200

application/json

OK

id · string · required

email · string · required

object · string · default: user

first_name · string · default: ""

last_name · string · default: ""

is_customer · boolean · default: true

email_domain · string | null

organization · Organization · object | null

created_at · string | null

permissions · PermissionMini · object[] | null

Show child attributes