contacts-v2

Update a contact's custom fields on a list

By default, merges the provided custom_fields into existing fields. Set merge_fields to false to replace entirely.

put/v2/contacts

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/contacts
  • Auth: API key in header X-Api-Key

Request body

custom_fieldsobject required

Custom fields key-value pairs to set

list_numberstring required

Sending list phone number in E.164 format

merge_fieldsboolean

If true (default), merge into existing custom_fields. If false, replace entirely.

phone_numberstring required

Contact phone number in E.164 format

Response

Contact updated

custom_fieldsobject

The full custom_fields after update

list_contact_idstring

ListContact ID

successboolean

Operation success

Changes

No recorded changes to this operation across all 1 revision of this API.