Skip to main content
POST
/
v1
/
contact-list
/
Create Contact List
curl --request POST \
  --url https://api.nedzo.ai/v1/contact-list/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "status_code": 123,
  "message": "<string>",
  "data": {
    "contact_list": {
      "name": "<string>",
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contacts": [
        {
          "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
name
string
required

The name of the contact list. This should be a descriptive title that helps identify the list's purpose or target audience.

campaign_id
string<uuid> | null

The unique identifier of the campaign associated with this contact list. If not provided, the contact list may not be tied to any specific campaign.

contact_ids
string<uuid>[] | null

A list of UUIDs representing the contacts included in this contact list. These are the contacts that will be part of the list. If not specified, an empty list is assumed.

Response

Successful Response

status_code
integer
required
message
string
required
data
object | null