channels
Open an operation to see its authentication, its parameters and the fields of its request and response.
7 operations
GET/v1/channels/{workspaceId}
Inbox, forwarding, sending address and recent mail of a workspace.
/v1/channels/{workspaceId}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspaceIdpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
workspace_idrequired | string | |
channel_idrequired | string | |
enabledrequired | boolean | |
inbox_in_planrequired | boolean | |
custom_domain_in_planrequired | boolean | |
inbound_addressrequired | string | |
white_label_addressrequired | string | |
accept_list_mailrequired | boolean | |
forwardingrequired | object | |
forwarding.addressrequired | string | |
forwarding.providerrequired | enum | Values gmail | outlook | other |
forwarding.added_atrequired | string (date-time) | |
forwarding.verified_atrequired | string (date-time) | |
forwarding.tested_atrequired | string (date-time) | |
forwarding.last_forwarded_atrequired | string (date-time) | |
forwarding.testrequired | object | |
forwarding.test.coderequired | string | |
forwarding.test.sent_atrequired | string (date-time) | |
forwarding.gmail_confirmationrequired | object | |
forwarding.gmail_confirmation.coderequired | string | |
forwarding.gmail_confirmation.urlrequired | string | |
forwarding.gmail_confirmation.requested_byrequired | string | |
forwarding.gmail_confirmation.received_atrequired | string (date-time) | |
forwarding.gmail_confirmation.verifiedrequired | boolean | |
pending_gmail_confirmationrequired | object | |
pending_gmail_confirmation.coderequired | string | |
pending_gmail_confirmation.urlrequired | string | |
pending_gmail_confirmation.requested_byrequired | string | |
pending_gmail_confirmation.received_atrequired | string (date-time) | |
pending_gmail_confirmation.verifiedrequired | boolean | |
sendingrequired | object | |
sending.kindrequired | enum | Values custom | default | white_label | not_ready |
sending.fromrequired | string | |
sending.reply_to_examplerequired | string | |
sending.missingrequired | array of enum | |
sending_domainrequired | object | |
sending_domain.namerequired | string | |
sending_domain.purposerequired | enum | Values sending | receiving |
sending_domain.brand_profile_idrequired | string | |
sending_domain.scoperequired | enum | Values workspace | organization |
sending_domain.statusrequired | enum | Values not_started | pending | verified | partially_verified | partially_failed | failed | temporary_failure |
sending_domain.recordsrequired | array of object | |
sending_domain.records[].purposerequired | enum | Values sending | receiving | status_page |
sending_domain.records[].record | string | |
sending_domain.records[].typerequired | enum | Values MX | TXT | CNAME | A | AAAA | CAA |
sending_domain.records[].namerequired | string | |
sending_domain.records[].valuerequired | string | |
sending_domain.records[].priority | integer | |
sending_domain.records[].ttl | string | integer | |
sending_domain.records[].status | enum | Values not_started | pending | verified | failed | temporary_failure |
sending_domain.records[].hostrequired | string | |
sending_domain.records[].requiredrequired | boolean | |
sending_domain.sender_emailrequired | string | |
sending_domain.sender_namerequired | string | |
sending_domain.verified_atrequired | string (date-time) | |
sending_domain.last_checked_atrequired | string (date-time) | |
sending_domain.created_atrequired | string (date-time) | |
receiving_domainrequired | object | |
receiving_domain.namerequired | string | |
receiving_domain.purposerequired | enum | Values sending | receiving |
receiving_domain.brand_profile_idrequired | string | |
receiving_domain.scoperequired | enum | Values workspace | organization |
receiving_domain.statusrequired | enum | Values not_started | pending | verified | partially_verified | partially_failed | failed | temporary_failure |
receiving_domain.recordsrequired | array of object | |
receiving_domain.records[].purposerequired | enum | Values sending | receiving | status_page |
receiving_domain.records[].record | string | |
receiving_domain.records[].typerequired | enum | Values MX | TXT | CNAME | A | AAAA | CAA |
receiving_domain.records[].namerequired | string | |
receiving_domain.records[].valuerequired | string | |
receiving_domain.records[].priority | integer | |
receiving_domain.records[].ttl | string | integer | |
receiving_domain.records[].status | enum | Values not_started | pending | verified | failed | temporary_failure |
receiving_domain.records[].hostrequired | string | |
receiving_domain.records[].requiredrequired | boolean | |
receiving_domain.sender_emailrequired | string | |
receiving_domain.sender_namerequired | string | |
receiving_domain.verified_atrequired | string (date-time) | |
receiving_domain.last_checked_atrequired | string (date-time) | |
receiving_domain.created_atrequired | string (date-time) | |
white_labelrequired | boolean |
PATCH/v1/channels/{workspaceId}
Turns the inbox on or off and chooses whether list mail opens tickets (owner, admin).
/v1/channels/{workspaceId}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspaceIdpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
enabled | boolean | |
accept_list_mail | boolean |
Response 200
The same fields as GET /v1/channels/{workspaceId}.
PUT/v1/channels/{workspaceId}/forwarding
Records the support address the customer forwards to the inbox (owner, admin).
/v1/channels/{workspaceId}/forwardingAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspaceIdpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
addressrequired | string (email) | |
providerrequired | enum | Values gmail | outlook | other |
Response 200
The same fields as GET /v1/channels/{workspaceId}.
DELETE/v1/channels/{workspaceId}/forwarding
Forgets the forwarded support address (owner, admin).
/v1/channels/{workspaceId}/forwardingAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspaceIdpathrequired | string |
Response 200
The same fields as GET /v1/channels/{workspaceId}.
POST/v1/channels/{workspaceId}/forwarding/test
Sends a test email to the support address; its return proves the forwarding.
/v1/channels/{workspaceId}/forwarding/testThe email carries a code in its subject and body. When it comes back to the inbox through the forwarding, the forwarding is marked verified. One test a minute (429 with Retry-After).
Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspaceIdpathrequired | string |
Response 200
The same fields as GET /v1/channels/{workspaceId}.
GET/v1/channels/{workspaceId}/inbound
Received email of the workspace, newest first, with what happened to each.
/v1/channels/{workspaceId}/inboundAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspaceIdpathrequired | string | |
cursorquery | string | |
limitquery | integer | |
statusquery | enum | Values processed | ignored | quarantined | released |
Response 200
| Name | Type | Description |
|---|---|---|
itemsrequired | array of object | |
items[].providerrequired | string | |
items[].email_idrequired | string | |
items[].fromrequired | string | |
items[].from_namerequired | string | |
items[].subjectrequired | string | |
items[].recipientrequired | string | |
items[].received_atrequired | string (date-time) | |
items[].statusrequired | enum | Values processed | ignored | quarantined | released |
items[].reasonrequired | enum | Values duplicate | auto_reply | bounce | no_reply | loop | mailing_list | forwarding_confirmation | forwarding_test | channel_disabled | not_in_plan | spam | rate_limited |
items[].ticket_idrequired | string | |
items[].spam_scorerequired | integer | |
items[].signalsrequired | array of string | |
items[].releasablerequired | boolean | |
next_cursorrequired | string |
POST/v1/channels/{workspaceId}/inbound/{provider}/{emailId}/release
Lets a quarantined email through: it opens (or joins) a ticket (owner, admin).
/v1/channels/{workspaceId}/inbound/{provider}/{emailId}/releaseAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
workspaceIdpathrequired | string | |
providerpathrequired | string | |
emailIdpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
ticket_idrequired | string | |
createdrequired | boolean |