DELETE /api/v2/users/{user_id}/identities/{user_identity_id}

Deletes the identity for a given user. In certain cases, a phone number associated with an identity is still visible on the user profile after the identity has been deleted via API. You can remove the phone number from the user profile by updating the phone attribute of the user to an empty string. See Update User via API for details and examples.

Deleting identities with type messaging could break messaging functionality. For example, an agent may stop being able to send messages via the messaging channel.

Allowed For

Servers

Path parameters

Name Type Required Description
user_identity_id Integer Yes

The ID of the user identity

user_id Integer Yes

The id of the user

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.