v1

latestSwagger 2.02026-08-06250450289.0 KB

contacts

Create a contact

post/v3/contacts

Request body

full_namestring

Full Name of contact

emailstring

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

phonestring

Phone number of the contact

mobilestring

Mobile number of the contact

job_titlestring

Job Title of the contact

contact_type'contact' | 'employee'

Type of contact

referenceIdstring

Reference ID of the anonymous contact

unique_idstring

Unique ID of the contact

unsubscribedboolean

Unsubscribed status of the contact

unsubscribe_textstring

Reason for unsubscribing

Example request

{
  "full_name": "Jane Doe",
  "email": "janedoe@surveysparrow.com",
  "phone": "91234567833",
  "mobile": "1653452783",
  "job_title": "Manager",
  "referenceId": "123456",
  "unique_id": "abc123",
  "unsubscribe_text": "Not interested"
}

Response

Successful