Update person by person_key

To update an existing person record, you can use the PUT method and the record’s unique person_key. In the request body, include any fields you’d like to update, and simply omit anything you’d like left as-is. To remove a value, you can set the value of the field to null.

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. You can remove the mobile_phone value if you specify the value as null. If an MDN is specified with a changed, non-null value, an HTTP 409 – Conflict Error will be returned.


A person entity reflecting the new state of the person will be returned, along with a status.

  • 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. 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!