Skip to main content
POST
/
v1
/
contact
/
Create Contact
curl --request POST \
  --url https://api.nedzo.ai/v1/contact/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "[email protected]",
  "first_name": "<string>",
  "last_name": "<string>",
  "full_name": "<string>",
  "business_name": "<string>",
  "full_address": "<string>",
  "city": "<string>",
  "country": "<string>",
  "state": "<string>",
  "postal_code": "<string>",
  "phone": "<string>",
  "job_title": "<string>",
  "dnc": true,
  "custom_fields": [
    {
      "custom_field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>"
    }
  ]
}
'
{
  "status_code": 123,
  "message": "<string>",
  "data": {
    "contact": {
      "contact_list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[email protected]",
      "first_name": "<string>",
      "last_name": "<string>",
      "full_name": "<string>",
      "business_name": "<string>",
      "full_address": "<string>",
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "phone": "<string>",
      "job_title": "<string>",
      "dnc": true,
      "custom_fields": [
        {
          "custom_field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "value": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_dial_time": "2023-11-07T05:31:56Z",
      "most_recent_outcome": "<string>",
      "status": "Waiting"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
email
string<email>
required

The email address of the contact. This field is required and should follow standard email format.

​
contact_list_id
string<uuid> | null

Unique identifier for the contact list that this contact belongs to. Optional, as the contact may not belong to a list.

​
first_name
string | null

The first name of the contact.

​
last_name
string | null

The last name of the contact.

​
full_name
string | null

The full name of the contact.

​
business_name
string | null

The name of the business the contact is associated with.

​
full_address
string | null

A full address for the contact, which may include street, city, state, and postal code.

​
city
string | null

The city where the contact resides or does business.

​
country
string | null

The country where the contact is located.

​
state
string | null

The state or province where the contact resides or does business.

​
postal_code
string | null

The postal code or ZIP code for the contact's address.

​
phone
string | null

The phone number of the contact.

​
job_title
string | null

The job title or role of the contact within their organization.

​
dnc
boolean | null
default:false

Do Not Contact flag. If set to True, this contact should be excluded from outreach campaigns.

​
custom_fields
CustomFieldValueCreate · object[] | null

Custom fields associated with the contact. These are user-defined attributes for additional information.

Response

Successful Response

​
status_code
integer
required
​
message
string
required
​
data
object | null