Save a draft for a new conversation

Saves a draft for a conversation that does not exist yet, so it can be reviewed and sent from the inbox. Provide connectedAccountId and recipients; a local draft thread is created and appears in the inbox with the draft filter. Local only; nothing is delivered, and the provider conversation is created when the draft is sent. subject, cc, and bcc apply to email accounts. Email needs at least one recipient across recipients, cc and bcc; use recipients: [] for Cc-only or Bcc-only email. Hidden Bcc recipients are never public thread participants. Every call creates a new draft conversation, also for recipients that already have one; to change a saved draft, save it again on its returned thread with POST /v1/messaging/threads/{id}/drafts.

POST
/v1/messaging/drafts

Authorization

apiKeyAuth
x-api-key<token>

API key authentication. Create an API key in your user profile and include it in the x-api-key header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://customermates.com/api/v1/messaging/drafts" \  -H "Content-Type: application/json" \  -d '{    "connectedAccountId": "ac03972a-5ca5-43c5-b96f-c519ac843b7a",    "recipients": [      "string"    ],    "body": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "messagingThreadId": "ea642f89-7688-4a10-9525-46b6c79cc287",
  "connectedAccountId": "ac03972a-5ca5-43c5-b96f-c519ac843b7a",
  "providerMessageId": "string",
  "provider": "google",
  "direction": "inbound",
  "sender": {
    "attendeeId": "string",
    "displayName": "string",
    "identifier": "string",
    "pictureUrl": "string",
    "profileUrl": "string",
    "headline": "string",
    "occupation": "string",
    "isSelf": true,
    "records": []
  },
  "recipients": {
    "to": [],
    "cc": [],
    "bcc": []
  },
  "subject": "string",
  "bodyText": "string",
  "bodyHtml": "string",
  "attachmentsMeta": [
    {
      "id": "string",
      "name": "string",
      "fileName": "string",
      "type": "string",
      "mime": "string",
      "size": 9007199254740991,
      "sticker": true,
      "voiceNote": true,
      "gif": true,
      "durationSeconds": 0,
      "unavailable": true,
      "linkUrl": "string"
    }
  ],
  "isEvent": false,
  "isDeleted": false,
  "isHidden": false,
  "isDraft": false,
  "sentAt": "string",
  "editedAt": "string",
  "reactions": [],
  "folderIds": [],
  "draftRevision": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
Empty