Update person by external_person_id

You can also use an external_person_id to add or update a person record. The external_person_id is defined by you and can be any unique identifying string of characters.

In the body request, include any fields that you’d like to add or update. Please note that you cannot edit the person_id, timezone_source, created_at, or updated_at fields; any values included in the request will be ignored.


The new person entity will be returned, along with a status code.

  • An HTTP 201 status code will be returned if the object has been successfully updated.
  • An HTTP 200 status code will be returned if an existing person record already exists with the same mobile_phone or the same external_person_id. 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 409 - CONFLICT ERROR will be returned if an update to the person's existing mobile_phone is attempted.
  • 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.
Click Try It! to start a request and see the response here!