Skip to main content

Overview

Similar things share one set of calls. A family has GET (list, or read one with id), POST (create), PATCH /{id} (change), DELETE /{id} and, where something happens rather than changes, POST /{id}/actions. A type field says which kind of thing you mean. The Sendora MCP has a matching action for each one, so an AI agent and your code use the same operations. All calls send X-API-Key. Writes need a key with write access. Ids are the public ids the API returns; send them back as they are.

Read several parts in one call

Reads take include, a comma list, so one request replaces many.

Change several settings in one call

A PATCH takes only what should change and runs its steps in a fixed order. If one step is refused, the earlier steps stay applied.

Work that waits on a person

GET /work-items?view=attention lists everything waiting on a person, most urgent first. Act on each kind:
  • Approvals: POST /work-items/{id}/actions with {"type": "approval", "decision": "approved"} or "rejected". A second decision answers 409.
  • Escalations: PATCH /work-items/{id} with {"type": "escalation", "status": ...}. Resolving needs resolution_type: retry runs the failed step again, skip moves on, manual only marks it fixed.
  • Tasks: PATCH /work-items/{id} with {"type": "task", "status": ...}.
  • Meetings: POST /work-items with {"type": "meeting", ...} records one; PATCH and DELETE change or cancel a manual one.
  • Conversations: POST /conversations/{lead_id}/actions with mark_read, archive, snooze (snoozed_until), pause_outreach, set_pipeline_stage, mark_meeting_booked, delete (undo with restore) and more.

Sending accounts, domains and pools

GET /connections?type=account lists the accounts you send from; type=domain lists email domains (include=dns adds the live records). A sender pool groups accounts or phone numbers under one rotation rule (least_used, round_robin, weighted or sticky_by_lead); add members in the same PATCH that changes anything else.

CRMs and integration health

GET /connections?type=crm lists the CRMs you connected. A connection’s id is its provider name, for example hubspot. Signing in to a CRM needs the owner to approve access in the app, so connecting stays there; everything after that is here: sync settings, field mapping, test, sync and import (use dry_run first to count without writing). GET /connections?type=health shows which connected accounts work and which need a person; POST /connections/{id}/actions with {"type": "health", "action": "check"} queues a fresh check.

The team, roles and settings

GET /workspace-settings?include=team lists members and invitations. POST /workspace-settings/actions invites, resends, revokes, suspends, reactivates and removes members and makes an owner (invite, resend_invite, revoke, suspend, reactivate, make_owner, remove_member), and adds or removes holidays. Only owners and admins can manage the team, and a key acts with the live role of the person who created it, so a key created by a manager cannot. include=access_catalog lists the roles and permissions; include=member_access&member_id= shows one member’s. PATCH /workspace-settings with team_access replaces a member’s role, extra grants or denials, and the campaigns or lead lists they are limited to. You cannot change your own access or the owner’s, cannot give a permission you do not hold, and one other admin must remain.

Billing

Billing is read only, as include=billing.* on GET /workspace-settings: balance and cycle, plan and status, this month’s usage, the spend cap and credit activity. Buying credits, changing plan and payment methods stay in the app, where the owner confirms them.

Phone numbers, start to finish

  1. Search: GET /phone-numbers?view=available&country_code=US&search_by=area_code&search_value=415 returns numbers with the price due now and monthly. Some countries need an address or document first: GET /phone-numbers?view=requirements&phone_number=..., then POST /phone-numbers with step regulatory_address or regulatory_document.
  2. Quote: POST /purchases with {"step": "quote", "kind": "phone_number", "selection": {"phone_number": "+14155550100"}}. Nothing is charged.
  3. Buy: POST /purchases with {"step": "buy", "kind": "phone_number", "quote_id": ..., "pay_with": "wallet"} (or card, which returns a checkout link a person opens) and an Idempotency-Key. A changed price answers 409; ask for a new quote. Follow the result with GET /purchases?operation_id=.
  4. Set up: PATCH /phone-numbers/{id} sets the inbound agent, outbound calling, the agent a number belongs to, its caller ID name, a verified caller ID and the sender ID.
  5. Look after it: GET /phone-numbers?id=...&include=history,usage shows recent texts and calls and what uses the number. POST /phone-numbers/{id}/actions can retry setup, send a test_message, send_documents the carrier asked for, or release it (a number that campaigns or agents use answers 409 with the list until confirm_unassign is true).
Domains, mailboxes and WhatsApp accounts are bought the same way with their own kind. Numbers from your own carrier account are imported with POST /phone-numbers (step search, confirm, outbound_profile, or twilio_search and twilio_confirm for your own Twilio account) and cost nothing.

Cloning a voice

POST /custom-voices with "type": "clone" takes a speech sample as audio_url (a public https link, up to 50 MB) or audio_base64 (up to 10 MB), plus name, gender, nationality and consent_confirmed: true. The provider charges for each clone, so send an Idempotency-Key and do not retry blindly. Without type, the same call adds a voice you already have at your speech provider.

Agency clients over their lifetime

GET /partner/clients?id=...&include=details,limits,audit,users shows one client with 30 days of usage and revenue, its monthly caps and access, what it did and what you changed, and its own people. PATCH /partner/clients/{id} changes branding, features, profile (name, owner, notes, renewal), usage_caps, access and users (invite, update, remove by email). POST .../actions activates, suspends, sets trial or closes a client (closing needs the exact name and can be undone in the app for 30 days). GET /partner/packages lists the plans you sell, POST /partner/packages creates one or, with package_id, publishes a new version, and PUT /partner/pricing saves and publishes your markup (publishing pricing is needed before packages).

Recordings

GET /calls/{call_id}/recording returns a call’s audio.