POST /api/v2/users/{user_id}/identities

Adds an identity to a user's profile. An agent can add an identity to any user profile.

Supported identity types:

TypeExample
email{ "type" : "email", "value" : "someone@example.com" }
twitter{ "type" : "twitter", "value" : "screen_name" }
facebook{ "type" : "facebook", "value" : "855769377321" }
google{ "type" : "google", "value" : "example@gmail.com" }
agent_forwarding{ "type" : "agent_forwarding", "value" : "+1 555-123-4567" }
phone_number{ "type" : "phone_number", "value" : "+1 555-123-4567" }

To create an identity without sending out a verification email, include a "skip_verify_email": true property. The "skip_verify_email": true property does not apply when updating your own agent profile. A welcome or verification email will be sent regardless of this setting.

Allowed For

Servers

Path parameters

Name Type Required Description
user_id Integer Yes

The id of the user

Query parameters

Name Type Required Description
type String No

Filters results by one or more identity types using the format ?type[]={type}&type[]={type}

Possible values:

  • "email"
  • "microsoft"
  • "facebook"
  • "phone_number"
  • "twitter"
  • "messaging"
  • "sdk"

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.