Fields

Outbound Mailbox objects have the following fields and links:

Fields

field name description
from_name name used to send email
from_email email used to send email
enabled indicates if the mailbox is enabled
default indicates if the mailbox is the default
reply_to reply to email address
hostname mail server hostname
port mail server port
last_error last error message recieved when attempting to send an email
type either postmark or custom
created_at when this record was created
updated_at when this record was last updated

Links

rel class embeddable? description
self outbound_mailbox no this mailbox

List

List all outbound mailboxes

GET https://yoursite.desk.com/api/v2/mailboxes/outbound

Applicable Roles

Agent, Reporting Agent, Workflow Manager, Knowledgebase Manager, Content Manager, Business Manager, Administrative Manager, Administrator, Knowledgebase Adminstrator, and Billing Administrator

Example Curl Request

1
2
3
$ curl https://yoursite.desk.com/api/v2/mailboxes/outbound \
    -u email:password \
    -H 'Accept: application/json'

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
  "total_entries": 2,
  "page": 1,
  "_links": {
    "self": {
      "href": "/api/v2/mailboxes/outbound?page=1&per_page=50",
      "class": "page"
    },
    "first": {
      "href": "/api/v2/mailboxes/outbound?page=1&per_page=50",
      "class": "page"
    },
    "last": {
      "href": "/api/v2/mailboxes/outbound?page=1&per_page=50",
      "class": "page"
    },
    "next": null,
    "previous": null
  },
  "_embedded": {
    "entries": [
      {
        "from_name": "Support",
        "from_email": "support@desk.com",
        "enabled": true,
        "default": true,
        "reply_to": "",
        "hostname": "smtp.example.com",
        "port": 587,
        "last_error": null,
        "type": "custom",
        "created_at": "2017-08-18T22:19:27Z",
        "updated_at": "2017-08-18T22:19:27Z",
        "_links": {
          "self": {
            "href": "/api/v2/mailboxes/outbound/1",
            "class": "outbound_mailbox"
          }
        }
      },
      {
        "from_name": "Another outbound mailbox",
        "from_email": "support@example.com",
        "enabled": true,
        "default": true,
        "reply_to": "",
        "hostname": "smtp.example.com",
        "port": 587,
        "last_error": null,
        "type": "custom",
        "created_at": "2017-08-18T22:19:27Z",
        "updated_at": "2017-08-18T22:19:27Z",
        "_links": {
          "self": {
            "href": "/api/v2/mailboxes/outbound/2",
            "class": "outbound_mailbox"
          }
        }
      }
    ]
  }
}

Show

Retrieve a single outbound mailbox

GET https://yoursite.desk.com/api/v2/mailboxes/outbound/:id

Applicable Roles

Agent, Reporting Agent, Workflow Manager, Knowledgebase Manager, Content Manager, Business Manager, Administrative Manager, Administrator, Knowledgebase Adminstrator, and Billing Administrator

Example Curl Request

1
2
3
$ curl https://yoursite.desk.com/api/v2/mailboxes/outbound/1 \
    -u email:password \
    -H 'Accept: application/json'

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "from_name": "Support",
  "from_email": "support@desk.com",
  "enabled": true,
  "default": true,
  "reply_to": "",
  "hostname": "smtp.example.com",
  "port": 587,
  "last_error": null,
  "type": "custom",
  "created_at": "2017-08-18T22:19:27Z",
  "updated_at": "2017-08-18T22:19:27Z",
  "_links": {
    "self": {
      "href": "/api/v2/mailboxes/outbound/1",
      "class": "outbound_mailbox"
    }
  }
}