Update a contact

PUT 
/v3/contacts/:id

Update a contact

Request

Path Parameters

id numberrequired

ID of the contact to be updated

application/json

Body

full_name string

Possible values: <= 255 characters

Full Name of contact

email string

Possible values: <= 255 characters

Email of contact. Can be optional only if anonymous contact feature is enabled.

phone string

Possible values: <= 255 characters

Phone number of the contact

mobile string

Possible values: <= 255 characters

Mobile number of the contact

job_title string

Possible values: <= 255 characters

Job Title of the contact

referenceId string

Possible values: <= 255 characters

Reference ID of the anonymous contact

Responses

200

Successful

*/*

Schema

Schema

data

object

id numberrequired

ID of the contact

name string

Full Name of contact

email string

Email of contact

active booleanrequired

if true, indicates the contact will actively receive email and sms shares

unsubscribed booleanrequired

if true, indicates that the contact is unsubscribed from receiving emails

unsubscribed_at daterequired

when the contact has unsubscribed

phone string

Phone number of the contact

mobile string

Mobile number of the contact

jobTitle string

Job Title of the contact

contactLists

object[]

List of Labels the contact has to be added into

Array [

id numberrequired

ID of the Label

name stringrequired

Name of the label

]

Example (from schema)

{
  "data": {
    "id": 1,
    "name": "Jane Doe",
    "email": "[email protected]",
    "active": true,
    "unsubscribed": false,
    "unsubscribed_at": "2023-08-28 12:26:56.899+05:30",
    "phone": "9123456783",
    "mobile": "8782828247",
    "jobTitle": "Manager",
    "contactLists": [
      {
        "id": 1,
        "name": "list1"
      },
      {
        "id": 2,
        "name": "list2"
      }
    ]
  }
}

Loading...