Contact Us
Log inStart Free Trial

API reference / Account and reference

Quick reference

Every public route, grouped the same way as the docs. Each link goes to the page that documents the route. REST routes are on https://api-v2.dropcowboy.com and Detection is on wss://detect.dropcowboy.com. Scopes are listed on each page and in the OpenAPI spec.

Get started

Method Route What it does
GET /openapi.yaml Get the OpenAPI spec, no credentials needed
GET /register/public/apikeys List API keys
POST /register/public/apikeys Create an API key
DELETE /register/public/apikeys/{key_id} Delete an API key
POST /phone/public/embed/token Create a site token

Outreach

Method Route What it does
POST /rvm Send a ringless voicemail
GET /campaign/public/deliveries/{drop_id}/receipt Get a new proof-of-delivery link
GET /campaign/public/receipts/{token} Play a proof of delivery, no credentials needed
POST /sms Send a text
POST /voice-broadcast Send a voice broadcast
POST /ai-broadcast Send an AI call
POST /email/public/email Send an email
POST /email/public/email/template Send an email and record its template
POST /email/public/email/merged-template Send an email from a template
GET /email/public/email List emails
GET /domain/public/mailboxes List sending mailboxes
GET /campaign/public/campaigns List campaigns
POST /campaign/public/campaigns Create a campaign
GET /campaign/public/campaigns/{id} Get a campaign
PUT /campaign/public/campaigns/{id} Update a campaign
DELETE /campaign/public/campaigns/{id} Delete a campaign
POST /campaign/public/campaigns/{id}/start Start a campaign
POST /campaign/public/campaigns/{id}/pause Pause a campaign
GET /campaign/public/campaigns/{id}/stats Get campaign stats
GET /phone/public/sms/{sms_id} Get a text
GET /phone/public/sms/thread/{contact_id} Get a contact's text thread
POST /phone/public/sms/reply Reply to a text
GET /chat/public/sites List web chat sites
POST /chat/public/reply Reply to a web chat

Track results

Method Route What it does
GET /register/public/events List event types
POST /register/public/webhooks Subscribe to an event
GET /register/public/webhooks List webhook subscriptions
GET /register/public/webhooks/{hook_type} Get a webhook subscription
DELETE /register/public/webhooks/{hook_type} Delete a webhook subscription
GET /register/public/account/webhook-signing-secret List webhook signing secrets

Voice and AI

Method Route What it does
GET /carrier/ws Open a Detection session over WebSocket
GET /carrier/ws/twilio Open a Detection session for a Twilio Media Stream
GET /register/public/detection-keys List Detection keys
POST /register/public/detection-keys Create a Detection key
DELETE /register/public/detection-keys/{key_id} Delete a Detection key
GET /voice/public/voices List voices
POST /voice/public/tts/synthesize Turn text into audio
POST /voice/public/voices/clone Clone a voice
POST /voice/public/voices/design Design a voice
DELETE /voice/public/voices/{voice_id} Delete a voice
POST /voice/public/asr/transcribe Transcribe audio
GET /agents/public/templates List agent templates
GET /agents/public/agents List AI agents
POST /agents/public/agents Create an AI agent
POST /agents/public/agents/from-template Create an AI agent from a template
GET /agents/public/agents/{agent_id} Get an AI agent
POST /agents/public/agents/{agent_id} Update an AI agent
DELETE /agents/public/agents/{agent_id} Delete an AI agent
POST /agents/public/agents/{agent_id}/publish Publish an AI agent
GET /document/public/knowledge-bases List knowledge bases
POST /document/public/knowledge-bases Create a knowledge base
GET /document/public/knowledge-bases/{knowledge_base_id} Get a knowledge base
POST /document/public/knowledge-bases/{knowledge_base_id} Update a knowledge base
DELETE /document/public/knowledge-bases/{knowledge_base_id} Delete a knowledge base
POST /document/public/knowledge-bases/{knowledge_base_id}/query Search a knowledge base
GET /document/public/knowledge-bases/{knowledge_base_id}/documents List a knowledge base's documents
POST /document/public/knowledge-bases/{knowledge_base_id}/documents Add a document to a knowledge base
POST /document/public/knowledge-bases/{knowledge_base_id}/documents/{knowledge_document_id}/uploaded Confirm a document upload
POST /document/public/knowledge-bases/{knowledge_base_id}/documents/{knowledge_document_id}/upload-url Get a new document upload URL
DELETE /document/public/knowledge-bases/{knowledge_base_id}/documents/{knowledge_document_id} Delete a document from a knowledge base
GET /phone/public/lines List phone lines
POST /phone/public/lines Create a phone line
GET /phone/public/lines/{line_id} Get a phone line
POST /phone/public/lines/{line_id} Update a phone line
DELETE /phone/public/lines/{line_id} Delete a phone line
POST /phone/public/lines/{line_id}/assign Assign a number to a phone line

Contacts

Method Route What it does
GET /contact/public/contacts List contacts
POST /contact/public/contacts Create a contact
GET /contact/public/contacts/search Search contacts by phone or email
GET /contact/public/contacts/{id} Get a contact
PUT /contact/public/contacts/{id} Update a contact
DELETE /contact/public/contacts/{id} Delete a contact
POST /contact/public/contacts/{id}/notes Add a note
GET /contact/public/contacts/{id}/notes List a contact's notes
GET /contact/public/contacts/{id}/follow-ups List a contact's follow-ups
POST /contact/public/contacts/{id}/follow-ups Create a follow-up
PUT /contact/public/follow-ups/{id} Update a follow-up
DELETE /contact/public/follow-ups/{id} Delete a follow-up
PUT /contact/public/contacts/{id}/owner Set a contact's owner
PUT /contact/public/contacts/{id}/disposition Set a contact's disposition
POST /contact/public/contacts/{id}/tags/{tag_id} Add a tag to a contact
DELETE /contact/public/contacts/{id}/tags/{tag_id} Remove a tag from a contact
GET /contact/public/fields List custom fields
GET /contact/public/contacts/{id}/timeline Get a contact's timeline
POST /register/public/events Add an event to a contact's timeline
GET /contact/public/lists List lists
POST /contact/public/lists Create a list
GET /contact/public/lists/{id} Get a list
PUT /contact/public/lists/{id} Update a list
DELETE /contact/public/lists/{id} Delete a list
GET /contact/public/lists/{id}/contacts List the contacts on a list
POST /contact/public/contacts/{id}/lists Add a contact to lists
DELETE /contact/public/contacts/{id}/lists/{list_id} Remove a contact from a list
POST /contact/public/contacts/{id}/lists/move Move a contact between lists
GET /tag/public/tags List tags
POST /tag/public/tags Create a tag
PUT /tag/public/tags/{tag_id} Update a tag
DELETE /tag/public/tags/{tag_id} Delete a tag
POST /tag/public/tags/bulk-delete Delete several tags
GET /contact/public/contacts/{id}/consent List a contact's consent records
POST /contact/public/contacts/{id}/consent Record consent
PUT /contact/public/contacts/{id}/consent/{cid}/revoke Revoke consent
POST /dnc/public/dnc Add a number to the do-not-contact list
GET /dnc/public/dnc/{phoneNumber} Check a number
GET /dnc/public/dnc/email/{email} Check an email
DELETE /dnc/public/dnc/{phoneNumber} Remove a number

Content

Method Route What it does
GET /media/public/media List media files
POST /media/public/media Add a media file
GET /media/public/media/{media_id} Get a media file
PUT /media/public/media/{media_id} Update a media file
DELETE /media/public/media/{media_id} Delete a media file
POST /media/public/media/{media_id}/complete Complete an upload
GET /media/public/media/{media_id}/policy Get new upload URLs
GET /template/public/templates List templates
GET /template/public/templates/{template_id} Get a template
POST /template/public/templates/{template_id}/merge Fill in a template for a contact
GET /document/public/documents List documents
POST /document/public/documents Upload a document
POST /document/public/documents/from-url Create a document from a URL
GET /document/public/documents/{id} Get a document
DELETE /document/public/documents/{id} Delete a document
GET /document/public/documents/{id}/url Get a download link

Phone and calls

Method Route What it does
GET /phone/public/numbers List phone numbers
POST /phone/public/numbers/rent Rent phone numbers
GET /phone/public/numbers/{number} Get a phone number
GET /phone/public/calls/{call_id} Get a call
GET /phone/public/calls/{call_id}/recording Get a call recording

Work management

Method Route What it does
GET /task/public/tasks List Inbox Tasks
GET /task/public/tasks/{task_id} Get an Inbox Task
POST /task/public/tasks Create an Inbox Task
PUT /task/public/tasks/{task_id} Update an Inbox Task
PUT /task/public/tasks/{task_id}/status Change an Inbox Task's status
GET /boards/public/boards List pipelines
POST /boards/public/boards Create a pipeline
PUT /boards/public/boards/{board_id} Update a pipeline
DELETE /boards/public/boards/{board_id} Delete a pipeline
POST /boards/public/boards/{board_id}/lists Add a list to a pipeline
DELETE /boards/public/boards/{board_id}/lists/{list_id} Remove a list from a pipeline
GET /automation/public/brands List registered brands
GET /automation/public/pools List number pools
GET /automation/public/dispositions List dispositions
POST /automation/public/contacts Create a contact with basic fields
POST /automation/public/contacts/find-or-create Find or create a contact
PUT /automation/public/contacts/list Add a contact to a list by phone, email or id
GET /integration/public/webhooks List integration webhooks
POST /integration/public/webhooks Create an integration webhook
GET /integration/public/webhooks/{id} Get an integration webhook
DELETE /integration/public/webhooks/{id} Delete an integration webhook

Account and reference

Method Route What it does
GET /register/public/account Get account info
GET /campaign/public/balance Get your balance
GET /user/public/users List users
GET /register/public/integration-readiness Check Building Blocks readiness
POST /register/public/building-blocks/enable Enable Building Blocks
GET /integration/public/byoc Get carrier status
POST /integration/public/byoc/connect Connect a carrier
POST /integration/public/byoc/disconnect Disconnect a carrier