Skip to content
/Email Inbox Configuration

Add a new Email Inbox

Request

POST /v3/email-inboxes

Add a new Email Inbox

Security
API_Key
Bodyapplication/jsonrequired

Create a new Email Inbox

namestringrequired
Example:"Adove Campaign Holidays, Marketing Department"
notesstring
labelIdsArray of integers, unique

The ids of the labels to be associated to the Email Inbox

subscribersobject
linkExclusionFiltersArray of strings
POST
/v3/email-inboxes
curl -i -X POST \
  https://api.observepoint.com/v3/email-inboxes \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Adove Campaign Holidays, Marketing Department",
    "notes": "string",
    "labelIds": [
      223
    ],
    "subscribers": {
      "onReceived": [
        "string"
      ],
      "onProcessed": [
        "string"
      ]
    },
    "linkExclusionFilters": [
      "string"
    ],
    "omitSocialLinks": true
  }'

Responses

Successful operation

Bodyapplication/json
idinteger, (int64)required
Example:10
labelIdsArray of integers, uniquerequired

The ids of the labels associated to the Email Inbox

namestringrequired
Example:"Christmas Marketing Campaign"
emailAddressstringrequired

The email address that has been assigned to the inbox

Example:"scanTest+<8^[a-z0-9]>@email.observepoint.com"
notesstring
subscribersobject
linkExclusionFiltersArray of stringsrequired
Response
{
  "id": 10,
  "labelIds": [
    223
  ],
  "name": "Christmas Marketing Campaign",
  "emailAddress": "scanTest+<8^[a-z0-9]>@email.observepoint.com",
  "notes": "string",
  "subscribers": {
    "onReceived": [ … ],
    "onProcessed": [ … ]
  },
  "linkExclusionFilters": [
    "string"
  ],
  "omitSocialLinks": true
}