Add a person

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

Adding a person and subscribing them to a list

Using the Add a participant API call, you can both create a person record and subscribe that person to a list with a single API call.

Note that you do not need to add a person record before subscribing a person to a list.

Request

Either the mobile_phone or external_person_id must be provided to create the unique record, but you can also include any custom field info you’d like.

The fields that cannot be updated are the person_id, timezone_sourced, created_at, and updated_at fields. These are generated by the system. Any values included will be ignored.

Path Params
string
required
Important: Please note that the "Try It" feature to the right will send an actual API call to our system, which may result in a new person record being created.
Body Params
string

A unique person identifier assigned by the brand, which can be used to link non-Vibes-assigned identifiers to Vibes person records. Max 128 characters.

mobile_phone
object

Object representation of a person's mobile phone. A person can have only one active mobile phone at a time.

custom_fields
object

List of custom field key/value pairs.

Headers
string
Defaults to 1
Responses

201

A person record has been created.

409

Conflict error. Generally, this occurs if you are attempting to create a person record with an MDN that is already associted with another person record.

422

The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json