ConnectCloud Comms API
Outgoing mail and webhooks: channels, templates, the delivery log, inbound webhooks and mailboxes.
The interactive reference needs JavaScript. Every operation also has its own page:
Settings
Channels
Delivery log
Inbound webhooks
Mailbox import
Mailboxes
GET /mailboxes Receiving mailboxes of the tenant (comms:read or desk:admin)POST /mailboxes Create a mailbox (comms:admin, desk:admin or hr:recruiting:manage; Microsoft 365 only comms:admin)GET /mailboxes/{id} One mailbox (comms:read; desk:admin its ticket mailboxes, hr:recruiting:manage its applicant mailboxes โ another module's mailbox answers 404)PUT /mailboxes/{id} Change name, switch, address and folders of a mailbox at its revision (comms:admin; desk:admin its ticket mailboxes, hr:recruiting:manage its applicant mailboxes; Microsoft 365 mailboxes only comms:admin)DELETE /mailboxes/{id} Delete a mailbox with its addresses (comms:admin; desk:admin its ticket mailboxes, hr:recruiting:manage its applicant mailboxes; Microsoft 365 mailboxes only comms:admin)POST /mailboxes/{id}/rotate Replace the address of a ticket or applicant mailbox (kind ses); the old one is accepted for graceDays (default 14) (comms:admin; desk:admin its ticket mailboxes, hr:recruiting:manage its applicant mailboxes)POST /mailboxes/{id}/check Sign in with the mailbox's Microsoft 365 connection and look up the folders of its address (comms:read; desk:admin its ticket mailboxes, hr:recruiting:manage its applicant mailboxes โ another module's mailbox answers 404)GET /mailboxes/{id}/mails Mails received by a mailbox, newest first (comms:read; desk:admin its ticket mailboxes, hr:recruiting:manage its applicant mailboxes โ another module's mailbox answers 404)