Update a contact
Partial update. Omitted fields are left alone.
email is NOT writable: an address is the contact's identity on this API, and rewriting it in place would silently change what every earlier send was addressed to. Create the new address instead.
custom_fields REPLACES the stored object rather than merging into it, so a key you omit is gone. Read the contact first if you mean to change one key and keep the rest.
Requires the contacts:write scope — Create, update, and delete your contacts.
AuthorizationBearer <API Key>API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.
id*stringResource id.
uuidapplication/json- body
Body for PATCH /api/v1/contacts/{id}. email is deliberately absent: an address is the contact's identity on this API, and changing it in place would silently rewrite what every earlier send was addressed to. Create the new address instead.
subscribed?booleancustom_fields?||||array<any>|Arbitrary JSON value (string, number, boolean, null, array, or object).
The updated contact
application/json- response
A contact as exposed on the v1 API.
id*stringuuidemail*stringsubscribed*booleancustom_fields*||||array<any>|Arbitrary JSON value (string, number, boolean, null, array, or object).
created_at*stringdate-timeupdated_at*stringdate-timecurl -X PATCH 'https://api.sendly.now/api/v1/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "string", "subscribed": true, "custom_fields": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}