Delete a User Identity

Delete a specified user identity

Deletes a specified user identity. To delete a user identity, you must first delete any ACS credentials and enrollment automations associated with the user identity. You must also deactivate any associated phones.

Request

Specify the desired user identity by including the corresponding user_identity_id in the request body.

Request Body Parameters

ParameterTypeDescription

user_identity_id

String Required

ID of the desired user identity

Sample Request

curl -X 'POST' \
  'https://connect.getseam.com/user_identities/delete' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_identity_id": "44d48b20-0dbe-419d-91ca-ab8bceecd135"
}'

Response

Returns a Boolean ok status indicator.

Sample Response

{
  "ok": true
}

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.