PATCH/v1/contacts/{id}contacts:write

Update a contact

Partial update. Fields not present in the body are left unchanged. To clear a field, send `null` explicitly.

Run a request

PATCH/v1/contacts/{id}

Base URL

Path

idrequired

Request body (JSON)

Resolved URL

PATCHhttps://coldos.justgotwyrd.com/api/v1/contacts/{id}

Paste an API key in the bar at the top of the page to enable Execute.

Parameters

Path parameters

iduuidrequired
The contact id.

Body parameters

internal_stagestringoptional
Funnel stage. Stage changes that regress the funnel rank are rejected unless `force_stage` is true.
force_stagebooleanoptionaldefault false
Override the funnel-rank guard.
custom_fieldsobjectoptional
Patch into `custom_fields` JSONB. Keys merge; pass `null` to delete a key.

Responses

400Invalid request — see `error.message`.
401Missing or invalid API key.
403Authenticated, but the key lacks the required scope.
404The referenced resource does not exist or is not visible to your key.
429Rate limit exceeded — see `Retry-After`.
500Unexpected server error. Safe to retry with idempotency-key.

Code samples

curl -X PATCH "https://coldos.justgotwyrd.com/api/v1/contacts/{id}" \
  -H "Authorization: Bearer $COLD_OS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "internal_stage": "meeting_booked"
    }'

Response · 200

{
  "id": "c2a8a93a-2f1c-4c5b-8f3d-9c1e3a8b5d12",
  "email": "ankit@example.com",
  "full_name": "Ankit Bhardwaj",
  "first_name": "Ankit",
  "last_name": "Bhardwaj",
  "title": "Head of Growth",
  "phone": "+919555516408",
  "mobile_phone": null,
  "whatsapp_number": "+919555516408",
  "linkedin_url": "https://www.linkedin.com/in/ankitbhardwaj",
  "organization_id": "9b2e1cd4-3c9b-4a1d-9b2f-21efae55c012",
  "internal_stage": "meeting_booked",
  "owner_id": "b1f2c3d4-5678-90ab-cdef-1234567890ab",
  "tags": [
    "high-intent",
    "warm-intro"
  ],
  "additional_emails": [],
  "additional_phones": [],
  "custom_fields": {
    "region": "APAC",
    "priority_score": 87
  },
  "last_engagement_at": "2026-05-01T14:30:00.000+05:30",
  "created_at": "2026-04-12T09:11:00.000+05:30",
  "updated_at": "2026-05-01T14:30:00.000+05:30"
}

Was this page helpful?

Your vote stays in this browser. We'll use it to prioritise rewrites.