Codique

DevelopersAPI reference

Developers · REST API

API reference

Every endpoint, the scope it needs and what it does.

On this page

Base path https://api.example.com/api/v1. Every request needs Authorization: Bearer <API key>. Requests and responses are JSON.

Conversations

RequestScopeDoes
GET /conversationsinbox:readList conversations. Filters: search, assignee, team_id, label, bucket (primary or general).
GET /conversations/:idinbox:readOne conversation
GET /conversations/:id/messagesinbox:readIts messages, with status
POST /conversations/:id/messagesinbox:sendSend a message. See Send messages.
POST /conversations/:id/notesinbox:sendAdd an internal note
POST /conversations/:id/assigninbox:assignAssign to a user or team
POST /conversations/:id/statusinbox:assignOpen, pending or closed
POST /conversations/:id/snoozeinbox:assignSnooze until a time
POST /conversations/:id/readinbox:readMark as read

Contacts

RequestScopeDoes
GET /contactscontact:readList. Filters: search, tag, stage; paging with limit (max 500) and offset. Returns items and total.
POST /contactscontact:createCreate, or update by phone. Body: phone, name, email, tagIds, attributes, phone_number_id. Returns conversation_id.
GET /contacts/:idcontact:readOne contact
PATCH /contacts/:idcontact:editUpdate fields
DELETE /contacts/:idcontact:deleteDelete
POST /contacts/:id/tagscontact:editAdd tags
DELETE /contacts/:id/tags/:tagIdcontact:editRemove a tag
GET /contacts/:id/timelinecontact:readEverything that happened to the contact
POST /contacts/:id/notescontact:editAdd a note
POST /contacts/:id/conversationinbox:readGet or open the contact’s conversation; returns conversation_id.
POST /contacts/importcontact:importImport many contacts
GET /contacts/export.csvcontact:exportDownload all contacts as CSV

Templates

RequestScopeDoes
GET /templatestemplate:readList templates and their status
GET /templates/resolve?name=&language=template:readA template’s variables and a preview
GET /templates/:idtemplate:readOne template
POST /templates/synctemplate:syncSync with Meta

Campaigns

RequestScopeDoes
GET /campaignscampaign:readList campaigns
POST /campaignscampaign:createCreate a draft campaign
GET /campaigns/:idcampaign:readOne campaign with its counts
GET /campaigns/:id/recipientscampaign:readEach recipient’s status
GET /campaigns/:id/export.csvcampaign:readRecipients as CSV
POST /campaigns/:id/launchcampaign:sendStart sending
POST /campaigns/:id/pause · /resumecampaign:sendPause or resume
POST /campaigns/:id/cancelcampaign:cancelCancel
RequestScopeDoes
GET /segmentscontact:readList segments
GET /segments/:id/contactscontact:readA segment’s members
GET /tags · POST /tagstag:read · tag:createList or create tags
GET /automation-flowsworkflow:viewPublished, active workflows
POST /automation-flows/:id/runworkflow:executeStart a workflow for a conversation. Body: {"conversation_id": "…"}.
GET /outbound-webhooks · POSTwebhook:read · webhook:createList or register webhooks
GET /search?q=contact:read and/or inbox:readSearch contacts and conversations

Note

Endpoints that need a feature outside your plan return 403 FEATURE_NOT_IN_PLAN. See Errors and limits.

Still stuck? Contact us with what you were doing and the exact message you saw.