List unsent drafts on an inbox

curl --request GET \
  --url https://core-api.getaptly.com/api/inboxes/{channelId}/drafts \
  --header 'x-token: <api-key>'

{
  "data": [
    {
      "streamId": "stm_abc",
      "uuid": "drf_123",
      "channelId": "acc-1",
      "subject": "Welcome",
      "content": "<p>Hi there</p>",
      "to": [
        {
          "value": "[email protected]"
        }
      ],
      "cc": [],
      "bcc": [],
      "attachments": [],
      "ownerId": "u_42",
      "sentBy": "u_42",
      "addedToOutboxAt": "2026-05-25T18:14:00.000Z"
    }
  ]
}

Inboxes

List unsent drafts on an inbox

Returns the unsent drafts on the given email inbox. The inbox is identified by its channelId — the same value returned as channelId from GET /api/users/{userId}/inboxes.

Each item in the response is a draft entry with the parent discussion’s streamId attached. Drafts currently in the process of sending (after POST /api/email/send was called and before the upstream provider accepts the message) are excluded.

With API-key auth the only scope check is that the inbox belongs to your company. With delegate-token auth (email:* scope) the inbox must also be one the authenticated user can reach personally or via a team membership.

GET

api

inboxes

{channelId}

drafts

List unsent drafts on an inbox

curl --request GET \
  --url https://core-api.getaptly.com/api/inboxes/{channelId}/drafts \
  --header 'x-token: <api-key>'

{
  "data": [
    {
      "streamId": "stm_abc",
      "uuid": "drf_123",
      "channelId": "acc-1",
      "subject": "Welcome",
      "content": "<p>Hi there</p>",
      "to": [
        {
          "value": "[email protected]"
        }
      ],
      "cc": [],
      "bcc": [],
      "attachments": [],
      "ownerId": "u_42",
      "sentBy": "u_42",
      "addedToOutboxAt": "2026-05-25T18:14:00.000Z"
    }
  ]
}

Authorizations

x-token

string

header

required

Path Parameters

channelId

string

required

External channel meta ID (meta.id) of the inbox.

Response

List of unsent drafts on the inbox.

data

object[]

Show child attributes

List a user's email inboxes Get board schema

Documentation Index

Authorizations

Path Parameters

Response