Skip to main content

​
MessageDesk Developer API

The Developer API is how integrations read and write a MessageDesk workspace on a user’s behalf. It’s a JSON-over-HTTPS API secured with OAuth 2.0.
Zapier is the only supported provider today. The endpoints in this reference are live and documented so you can see exactly what an integration does on your behalf, debug it, or plan one of your own. Registering your own application against the API isn’t self-service yet. If you’d like general API access, email us and tell us what you’re building. Setting up Zaps? Start with the Zapier integration guide instead.

​
How the API is organized

MessageDesk is provider agnostic. Every integration talks to the same API, and each one gets its own namespace under the base path:
Requests also name the calling provider in a developerProvider field so MessageDesk can shape responses and webhook payloads for it. The value is zapier for everything documented here. Endpoints fall into three groups:

​
Conventions

  • Authentication is an OAuth 2.0 bearer token on every request. See Authentication.
  • Every request starts with your workspace. Action bodies carry the workspace ID in a field named id; lookups take it as the workspaceId query parameter. You can only act on workspaces you’re a member of.
  • Phone numbers are accepted in any common US format and normalized to E.164 (+15551234567). Responses always return E.164.
  • Timestamps are RFC 3339 strings in UTC.
  • Content type is application/json for requests and responses.

​
Where to go next

Authentication

How OAuth 2.0 tokens are issued and sent.

Webhooks

Subscribe a URL to messages, calls, comments, contact changes and opt-outs.

Errors

Status codes, error bodies and how validation failures are reported.

API reference

Every endpoint, with request and response schemas generated from the API itself.