Skip to main content
PATCH
/
contacts
/
{id}
Update an existing Contact
curl --request PATCH \
  --url https://commerce.driv.ly/api/contacts/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "cnt_8dk3j2ksl9d2",
  "roles": [
    "Manager",
    "Sales"
  ],
  "lastName": "Smith",
  "firstName": "Alice"
}'
{
  "data": {
    "id": "cnt_8dk3j2ksl9d2",
    "roles": [
      "Manager",
      "Sales"
    ],
    "lastName": "Smith",
    "firstName": "Alice"
  },
  "success": true
}

Path Parameters

id
string
required

Contact is uniquely identified by id

Query Parameters

depth
integer

The number of levels of related objects to include in the response

Body

application/json
id
string

Contact is uniquely identified by id

agent

Contact is automated Agent

address

Contact has Address

primaryPhoneNumber
string

Contact has Primary Phone Number

primaryEmail
string<idn-email>

Contact has Primary Email

lastName
string

Contact has Last Name

firstName
string

Contact has First Name

emails
string<idn-email>[]

Contact has Email

phoneNumbers
string[]

Contact has Phone Number

roles
string[]

Contact has Role

Response

Contact Updated

data
object
Examples:
{
"id": "cnt_8dk3j2ksl9d2",
"roles": ["Manager", "Sales"],
"lastName": "Smith",
"firstName": "Alice"
}
success
boolean
I