Skip to main content
PATCH
Edit a contact
Anything you leave out stays as it is. The fields follow the same rules as Add a contact.
  • Customer list: a contact can’t be moved to another list. If you send customerListId, it’s ignored.
  • variantValues replaces them all. Values for variants you leave out of the list are deleted. To change one value, send every value the contact should keep. Leave variantValues out entirely to keep them as they are.
  • Phone number: a new number is checked for duplicates in the contact’s list, the same as when adding.

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required

The contact's id.

Body

application/json
phoneNumber
string
Required string length: 1 - 50
Example:

"+201001234567"

firstName
string
Maximum string length: 100
Example:

"Ahmed"

lastName
string
Maximum string length: 100
Example:

"Hassan"

email
string<email>
Maximum string length: 50
gender
string

Free text.

Maximum string length: 50
Example:

"male"

variantValues
object[]

Replaces all of the contact's values. Values for variants you leave out are deleted. Leave this field out to keep them as they are.

Response

The updated contact.

message
string
Example:

"Contact updated successfully"

data
object