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 (inboxes:* scope) the inbox must also be one the authenticated user can reach personally or via a team membership.
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
External channel meta ID (meta.id) of the inbox.
Response
List of unsent drafts on the inbox.
Changes
No recorded changes to this operation across all 1 revision of this API.