Sign in
identity

Update an end user (merge-on-conflict requires ?allow_merge=true)

put/v1/identity/end-users/{end_user_id}

Path parameters

end_user_idstring uuid required

Query parameters

allow_mergeboolean

Request body

display_namestring nullable
primary_emailstring nullable
primary_phonestring nullable
metadataobject nullable
org_external_end_user_idstring nullable

Response

Successful Response

uidstring required
org_idstring required
statusstring required
display_namestring nullable
primary_emailstring nullable
primary_phonestring nullable
metadataobject
org_external_end_user_idstring nullable
merged_intostring nullable
dropped_external_idsstring[]

Changes

Changed in 1 of the 3 revisions of this API.39

  • 5a5597ebb2d639See the full diff
    • ●

      the display_name/anyOf[subschema #1]/ request property's maxLength was set to 255

      request-property-max-length-set

    • ●

      the primary_email/anyOf[subschema #1]/ request property's maxLength was set to 255

      request-property-max-length-set

    • ●

      the primary_phone/anyOf[subschema #1]/ request property's maxLength was set to 255

      request-property-max-length-set

    • ○

      added the new optional query request parameter allow_merge

      new-optional-request-parameter

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

    • ○

      added the optional property dropped_external_ids to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property retry_after to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property retry_after to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property retry_after to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 404 status

      response-optional-property-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog