API Reference
Complete reference documentation for all Vocalis API endpoints.
Base URL
https://vocalis.io/api/v1Content Type
All requests and responses use JSON. Set the Content-Type header to application/json for POST/PATCH requests.
Endpoints
GET
/api/v1/contact-listsList Contact Lists
Get a list of all contact lists in your account
POST
/api/v1/contact-listsCreate Contact List
Create a new contact list with a custom schema
GET
/api/v1/contact-lists/:idGet Contact List
Get details of a specific contact list
PATCH
/api/v1/contact-lists/:id/schemaUpdate Schema
Update the schema of a contact list
GET
/api/v1/contact-lists/:id/contactsList Contacts
Get paginated list of contacts in a contact list
POST
/api/v1/contact-lists/:id/contactsImport Contacts
Import contacts to a contact list (async)
GET
/api/v1/import-jobsList Import Jobs
Get a list of all import jobs
GET
/api/v1/import-jobs/:idGet Import Job
Get status and progress of a specific import job
POST
/api/v1/import-jobs/:id/cancelCancel Import Job
Cancel a running import job