Skip to main content
PATCH
/
api
/
v1
/
contacts
/
{contactId}
curl -X PATCH "https://api.usegately.com/api/v1/contacts/CONTACT_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Project-ID: YOUR_PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "inactive",
    "notes": "Churned after trial"
  }'

{
  "id": "a1b2c3d4-e5f6-4789-abcd-ef1234567890",
  "name": "Jane Smith",
  "email": "jane@example.com",
  "status": "inactive",
  "notes": "Churned after trial",
  "last_contacted_at": "2025-06-15T14:30:00.000Z",
  "updated_at": "2025-06-15T14:30:00.000Z"
}

​
Headers

​
Authorization
string
required
Bearer YOUR_API_KEY
​
X-Project-ID
string
Your project UUID. Not required if the API key already encodes the project.

​
Path Parameters

​
contactId
string
required
The contact UUID

​
Request Body

All fields are optional. Only the fields you include will be updated.
​
name
string
Full name
​
email
string
Email address
​
phone
string
Phone number
​
mobile
string
Mobile number
​
company
string
Company name
​
status
string
new · active · inactive · archived
​
notes
string
Internal notes
​
first_name
string
First name
​
last_name
string
Last name
​
city
string
City
​
state
string
State or province
​
zip
string
Postal / ZIP code
​
country
string
Country
​
custom_fields
object
Replaces the entire custom_fields object. Use the custom fields endpoint for a merge-patch instead.
​
tags
string[]
Replaces all existing tags on the contact when provided.
​
unsubscribed
boolean
Set to true to mark as unsubscribed. Prefer the dedicated unsubscribe endpoint for a full audit trail.

​
Response

Returns the updated contact object. 
curl -X PATCH "https://api.usegately.com/api/v1/contacts/CONTACT_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Project-ID: YOUR_PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "inactive",
    "notes": "Churned after trial"
  }'

{
  "id": "a1b2c3d4-e5f6-4789-abcd-ef1234567890",
  "name": "Jane Smith",
  "email": "jane@example.com",
  "status": "inactive",
  "notes": "Churned after trial",
  "last_contacted_at": "2025-06-15T14:30:00.000Z",
  "updated_at": "2025-06-15T14:30:00.000Z"
}