Deskhero Developer Hub
Back to deskhero.com
Mailboxes

Verify forward

Sends a test email to the mailbox address so the forwarding rule set up on your own domain can be proven to reach Deskhero. Only accepted for a mailbox on your own domain that is still in require-forward state, and the acknowledgement only says the message was sent, not that the forward worked.

POST /api/{tenant:minlength(2)}/v{version:apiVersion}/mailboxes/verify_forward
Authorisation
Minimum role: ADMIN

Request arguments

Name Type Source
inputDTO_idBody
Request body example

Response

Status
200 (OK)
Type
DTO_acknowledgement
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 403 (Forbidden)
Response body example
DTO_id
NameTypeReadOnlyDescription
idInt32Id
DTO_acknowledgement
NameTypeReadOnlyDescription
messageStringMessage

Generated Aug 4, 2026 18:37