Contacts

Update a contact

Update name fields, subscription status, or custom properties. Email addresses cannot be changed.

patch/v1/contacts/{id}

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/contacts/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The contact ID or URL-encoded email address

Request body

firstNamestring
lastNamestring
first_namestring
last_namestring
unsubscribedboolean
propertiesobject
segment_idsstring[]

Replace this contact's manual segment assignments

Example request

{
  "firstName": "Steve",
  "lastName": "Wozniak",
  "first_name": "Steve",
  "last_name": "Wozniak",
  "unsubscribed": true,
  "properties": {
    "company": "Acme"
  },
  "segment_ids": [
    "clx_segment123"
  ]
}

Response

Contact updated

objectstring required
idstring required

Example response

{
  "object": "contact",
  "id": "clx_contact123"
}

Changes

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