Mint this workspace's inbound email address
Issue the workspace's inbound address, or return the one it already has.
/v1/channels/email/addressAdmin- Operation id
- create_inbound_address
- Access
- An editor or a viewer is refused.
/v1/channels/email/addressIssue the workspace's inbound address, or return the one it already has.
Idempotent: connecting the channel twice is a second click, not a request for a second address. The local part is a minted random token rather than anything derived from the workspace, because the address is public and a guessable one is an open write path into this workspace's ticket queue.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: admin or owner. An editor or viewer receives 403 insufficient_role.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the channels:write scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/channels/email/address"{ "address": "string", "domain": "string", "minted": true}