API ReferenceContacts
Update a contact
PATCH
Update data and/or subscribed. email is immutable here — use /api/contacts/upsert to change addresses.
Requires the contacts:write scope — Create, update, and delete your contacts.
header
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*stringFormat
uuidapplication/json- body
Body for PATCH /api/contacts/{id}. email is immutable here — use upsert to change addresses.
subscribed?booleancustomFields?Updated contact
application/json- response
success*trueValue in
truedata*A subscriber/contact within a project.
curl -X PATCH 'https://api.sendly.now/api/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "success": true, "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "email": "user@example.com", "subscribed": true, "customFields": { "property1": null, "property2": null }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}