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>"
  ],
  "ticket_form_id": "<string>",
  "additional_info": {},
  "business_context": {},
  "is_reviewer": true,
  "is_viewer": true
}
'

200

{
  "id": "<string>",
  "email": "<string>",
  "object": "user",
  "first_name": "",
  "last_name": "",
  "is_customer": true,
  "email_domain": "<string>",
  "organization": {},
  "created_at": "<string>",
  "ticket_form": {},
  "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.

ticket_form_id attaches a ticket form to the user, which takes priority over the one resolved from their permissions. Pass an empty string to detach it.

email · string · required

first_name · string | null

last_name · string | null

organization_id · string | null

permission_ids · string[] | null

ticket_form_id · 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

ticket_form · Ticket Form · object | null

permissions · PermissionMini · object[] | null

Show child attributes