Skip to main content
Resend Docs

Search documentation

Type to search this documentation.

Update a single contact by ID or email

PATCH/contacts/{id}Update a single contact by ID or email

Parameters

idstringpathrequired

The Contact ID or email address.

Request body

application/json
objectUpdateContactOptions
emailstring

Email address of the contact.

first_namestring

First name of the contact.

last_namestring

Last name of the contact.

propertiesobject

A map of custom property keys and values to update.

unsubscribedboolean

The Contact's global subscription status. If set to true, the contact will be unsubscribed from all Broadcasts.

Example request
{
  "email": "steve.wozniak@gmail.com",
  "first_name": "Steve",
  "last_name": "Wozniak",
  "properties": {
    "additionalProp1": null
  },
  "unsubscribed": false
}

Responses

200OKapplication/json
objectUpdateContactResponseSuccess
idstring

Unique identifier for the updated contact.

objectstring

Type of the response object.

Example response
{
  "id": "479e3145-dd38-476b-932c-529ceb705947",
  "object": "contact"
}
Documentation menu