Update an existing Email Inbox

Request

PUT /v3/email-inboxes/{emailInboxId}

Update an existing Email Inbox by Id

Security

API_Key

Path

emailInboxIdintegerrequired

Unique identification number for email inbox

Bodyapplication/jsonrequired

Update an existent 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

omitSocialLinksboolean

PUT

/v3/email-inboxes/{emailInboxId}

curl -i -X PUT \
  'https://api.observepoint.com/v3/email-inboxes/{emailInboxId}' \
  -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

omitSocialLinksbooleanrequired

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
}