Skip to content
Pinlyx Docs
Open app

Update a contact

PATCH
/v1/contacts/{id}

Partially updates a contact. A property you leave out is left alone; a property set to null clears that column. That difference is the whole point of PATCH here - {"company": null} erases the company, {} changes nothing (and returns 400, since a no-op update is almost always a bug).

customFields merges into the existing object, and a null value drops that one key. tags, when present, replaces the contact’s whole tag set. Changing externalId to one already used in the workspace returns 409.

Emits contact.updated with a changedFields list, plus pipeline.stage_changed when pipelineStageId moved. Send Idempotency-Key to make a retry safe. Requires scope contacts:write.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
integer

Header Parameters

Section titled “Header Parameters ”
X-Workspace-Id
integer

Act on this workspace’s shared CRM pool. Membership is verified on every request, so an id you do not belong to falls back to personal scope rather than widening access. Omit it to use your default workspace. Applies to every CRM endpoint, not only the ones that list it here.

Idempotency-Key
string
<= 255 characters

A unique string of your choosing (a UUID works). The first request with this key runs normally and its response is stored for 24 hours; a retry with the same key returns that stored response verbatim, with Idempotency-Replayed: true, instead of writing again. Reusing a key with a different body returns 409.

Request Body required

Section titled “Request Body required ”

Every property is optional. A property you omit is left alone; a property set to null clears that column. At least one recognised property must be present. Accepts the same fields as CreateContactRequest, plus tags, which replaces the contact’s whole tag set rather than adding to it.

object
platform
string
nullable
Allowed values: telegram twitter
name
string
nullable <= 100 characters
username
string
nullable <= 100 characters
phone
string
nullable <= 20 characters
email
string
nullable <= 200 characters
company
string
nullable <= 200 characters
externalId
string
nullable <= 100 characters
country
string
nullable <= 100 characters
city
string
nullable <= 100 characters
notes
string
nullable <= 500 characters
stage
string
nullable
Allowed values: novalue lead conversation proposal negotiation won lost
pipelineStageId
integer
nullable
leadScore
integer
nullable <= 100
source
string
nullable
tags

Replaces the contact’s tags. Send [] to remove them all.

Array<string>
nullable
customFields

Merged into the existing values. A null value drops that key; null for the whole object clears every key.

object
Example
{
  "company": "Analytical Engines Ltd",
  "city": "London",
  "notes": null,
  "stage": "conversation",
  "customFields": {
    "lifetime_value": 5100,
    "churn_risk": null
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated contact.

A CRM contact record.

object
id
integer
platform

Social platform the contact belongs to.

string
Allowed values: telegram twitter
name
string
nullable
username

Handle without the leading @.

string
nullable
phone
string
nullable
email
string
nullable
company
string
nullable
externalId

The contact’s id in your own system. The stable key the batch endpoint upserts on.

string
nullable <= 100 characters
country
string
nullable
city
string
nullable
notes
string
nullable
stage

CRM pipeline stage.

string
leadScore

Lead score 0-100 (higher = hotter). Null when not scored.

integer
nullable
leadScoreIsAi

True when the score was last set by AI, false for a manual override.

boolean
assignedToUserId

Team member the contact is assigned to.

integer
nullable
ownerUserId

Workspace member the row is filed under. Differs from the caller in a shared pool.

integer
nullable
pipelineId

Custom pipeline board the contact sits on.

integer
nullable
pipelineStageId

Column within pipelineId.

integer
nullable
source

How the contact entered the CRM (OutboundMessage, InboundMessage, Manual, CsvImport, Extension, …).

string
isArchived

True once the contact has been soft-deleted or archived.

boolean
createdAt
string format: date-time
updatedAt
string format: date-time
nullable
lastMessageAt
string format: date-time
nullable
hasUnreadMessages
boolean
customFields

Custom field values keyed by field key. Null when the contact has none.

object
tags

Attached tags (populated on GET by id, omitted in list responses).

Array<object>
nullable
object
id
integer
name
string
color

Hex color

string

400

Section titled “400 ”

The request body or parameters failed validation.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "bad_request",
  "message": "at least one of name, username, phone is required"
}

401

Section titled “401 ”

Missing or invalid bearer token.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "unauthorized",
  "message": "Invalid bearer principal"
}

403

Section titled “403 ”

The API key does not have the required scope for this operation.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "forbidden",
  "message": "scope contacts:write is required"
}

404

Section titled “404 ”

The requested resource does not exist or is not owned by the caller.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "not_found",
  "message": "contact not found"
}

409

Section titled “409 ”

The request collides with existing state: a duplicate externalId, an Idempotency-Key replayed with a different body or still in flight, or a permanent delete blocked by records that still reference the contact.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "conflict",
  "message": "a contact with externalId 'shopify-cust-88213' already exists",
  "details": {
    "existingContactId": 4821
  }
}

429

Section titled “429 ”

Per-key rate limit exceeded. Retry after the time indicated by X-RateLimit-Reset.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "rate_limited",
  "message": "rate limit exceeded"
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests allowed per minute for this key.

X-RateLimit-Remaining
integer

Requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp (seconds) when the rate limit window resets.