Rest API

Use the Missive REST API to enrich conversations, automate drafts, sync contacts, and more.

The Missive API lets you enrich Missive conversations with content from anywhere on the web. You can also automate tasks such as creating and sending drafts, syncing contacts and more.

Example of a post created using the REST API

e.g. An action in another app inserting a post in a conversation.

Basics

The API is a collection of endpoints with a method (eg. POST) and a URL in the form of:

https://public.missiveapp.com/v1/:endpoint_name

Authentication

To start using the API, you first need to get your API token. Get it from your Missive preferences, click the API tab, then the Create a new token link.

You need to be part of an organization subscribed to the Productive plan in order to generate API tokens.

You must transmit your user token as a Bearer token in the Authorization HTTP header.

Example request

POST /v1/drafts
Host: public.missiveapp.com
Authorization: Bearer missive_pat-26pApm_QTmyhLLbA...FwoFGmJ6x-6fikpQ

All API tokens are personal. There is no organization-level or shared-account-specific token. Your personal token has access to any account you can access in Missive, including shared accounts. Use the account or mailbox parameters in your requests to filter results to a specific shared account.

Responses

All API responses are formatted as JSON, including errors. Successful POST requests may return the 201 status code with no body.

Evaluating responses

You should infer the success of your requests from the returned HTTP status code. A successful request will return either a 200 or 201 status code.

POST bodies

You must explicitly send POST requests with Content-Type: application/json.

Example POST

POST /v1/drafts
Host: public.missiveapp.com
Authorization: Bearer missive_pat-26pApm_QTmyhLLbA...FwoFGmJ6x-6fikpQ
Content-Type: application/json

{"drafts":{}}

Resource IDs

To interact with resources via the API, you will need those resource's ID. For instance, if you want to apply a label to a conversation when creating a post, you will need the label ID. You can get those resources IDs by opening the API settings and clicking on the Resource IDs tab.

Find resource IDs in your API settings

Settings > API > Resource IDs

Last updated on February 24, 2020

Need more specific answers?

Contact us