Skip to content
Pinlyx Docs
Open app

Merge custom field values into a contact

PUT
/v1/contacts/{id}/custom-fields

Merges the supplied values into the contact. Keys you do not mention are left alone and a null value clears that one key - the same contract the panel uses, so an integration and a human editing the same contact cannot wipe each other’s fields. At most 100 keys per contact, each key at most 50 characters. Emits contact.updated. 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.

Request Body required

Section titled “Request Body required ”
object
values
required

Custom field values keyed by the fieldKey of a definition from GET /v1/custom-fields. Values may be any JSON scalar. At most 100 keys per contact; each key at most 50 characters.

object
key
additional properties
any
Example
{
  "lifetime_value": 4820,
  "preferred_channel": "email"
}
Example
{
  "values": {
    "lifetime_value": 5100,
    "preferred_channel": "email",
    "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"
}