endUsers

Update an end user

Update a specific end user by id

patch/v2/end-users/{end_user_id}

Request

  • Base URL: https://example.ada.support/api
  • URL: https://example.ada.support/api/v2/end-users/{end_user_id}
  • Auth: HTTP bearer

Path parameters

end_user_idstring id required

The Ada end_user_id

Request body

external_idstring nullable

Set or update the external identifier for this end user. Pass null to remove the current external_id. Must be unique per AI Agent; maximum 36 characters; must not contain < or > characters. Values are stored case-insensitively. Returns 409 if the external_id is already assigned to a different end user. Available for custom channel integrations only (V1).

Response

OK

end_user_idstring

The unique Ada-generated id for the end user

external_idstring nullable

Caller-supplied identifier that links this end user to your own system (for example a CRM contact ID or a phone number). Unique per AI Agent. Null if not set. Maximum 36 characters; values are case-insensitive. Available for custom channel integrations only (V1).

created_atstring

The date and time the end user was created

updated_atstring

The date and time the end user was updated

Changes

No recorded changes to this operation across all 1 revision of this API.