Using the POST
method, you can create a new person record. Note that this call does not subscribe this person to any subscription list. To subscribe a person to a list, use the Add a participant API call.
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.
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.
Response
The created person entity will be returned, along with a response code.
- An
HTTP 201
status code means success. You should also receive a response with the created object. - An
HTTP 200
status code will be returned if an existing person record already exists with the same mobile_phone. The record will be updated with the added information. Specified fields in the add request will be applied and any existing data fields on the record will remain unchanged. - An
HTTP 200
status code will be returned if an existing person record already exists, either with the external_person_id or with the samemobile_phone
. The record will be updated with the added information. Specified fields in thePUT
request will be applied, and any existing data fields on the record will remain unchanged. Theexternal_person_id
of the person in the URL will change to theexternal_person_id
in the request if specified. - An
HTTP 409 - CONFLICT ERROR
will be returned if the update contains a mobile_phone value that already exists. - An
HTTP 422 - Unprocessable Entity
response status code indicates that 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.