Skip to main content
POST
/
v1
/
contact-lists
Create Contact Lists
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        name: '<string>',
        default_sequence_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ]
  })
};

fetch('https://api.topo.io/v1/contact-lists', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": [
    {
      "index": 123,
      "resource": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "default_sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entries_count": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "error": {
        "type": "<string>",
        "message": "<string>"
      }
    }
  ],
  "summary": {
    "total": 123,
    "succeeded": 123,
    "failed": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Body

application/json

Create Contact Lists payload

items
ContactListInput · object[]
required

Contact lists to create.

Required array length: 1 - 100 elements

Response

200 - application/json

Successful Response

items
BatchItemResult[ContactListOutput] · object[]
required
summary
BatchSummary · object
required