Sirportly

Toggle Menu

E-Mail Addresses

This method allows you to access all system-configured e-mail addresses which are used to accept and send e-mails.

URL

/api/v2/objects/email_addresses

Access

All types of access are permitted to access this method.

Supported Parameters

  • department - the ID of the department you wish to query (required)

Returned Data

You will receive two arrays, one containing the addresses for the department you have queried. The other contains the addresses belonging to other departments within the same brand as the department queried.

Example JSON

{
    "department": [
        {
            "id": 2,
            "address": "adamdev@email2.sirportly.com",
            "allow_outbound": true,
            "subject_prefix": null,
            "send_as_user": false,
            "test_enabled": true
        }
    ],
    "brand": [
        {
            "id": 3,
            "address": "blah@email2.sirportly.com",
            "allow_outbound": true,
            "subject_prefix": "",
            "send_as_user": false,
            "test_enabled": true
        }
    ]
}