Skip to main content
PATCH
Node.js

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer rw_....

Required scope: project:write.

Path Parameters

id
string
required

Contact identifier returned by Rewrite.

Example:

"748395130237498412"

Body

application/json
phone
string

Updated destination number. Rewrite normalizes it before persisting.

Minimum string length: 8
Example:

"+5511888888888"

name
string

Updated contact label.

Required string length: 1 - 80
Example:

"Fernanda Silva"

channel
enum<string>

Updated preferred channel.

Available options:
SMS,
OTP
Example:

"OTP"

tagIds
string[]

Replacement tag set linked to the contact. Existing relations are synchronized.

Maximum array length: 15
Example:
tags
object

Replacement metadata stored with the contact.

preferredLanguages
string[]

Updated locale preference list for the contact.

Example:

Response

200 - application/json

Successful response

ok
boolean
required
data
null
required