Contacts

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.

patch/api/v1/contacts/{id}

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/contacts/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: contacts:write)

Path parameters

idstring uuid required

Resource id.

Request body

subscribedboolean

Response

The updated contact

created_atstring date-time required
emailstring required
idstring uuid required
subscribedboolean required
updated_atstring date-time required

Changes

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