Ticketing_BlockedSender
Block sender,reject or mark as junk message.
Blocked Senders
- Blocked Senders Manage
GET ticketing/blockedSenders
GET ticketing/blockedSenders/{id}
POST ticketing/blockedSenders
PUT ticketing/blockedSenders/{id}
DELETE ticketing/blockedSenders/{id}
Model
Ticketing_BlockedSender JSON Format
Ticketing_BlockedSender is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of blocked sender. |
identityValueOrDomain |
string | Blocked email or domain. |
blockLevel |
string | How to block a message. Allowed values are "markFutureMessagesAsJunk", "rejectAllFutureMessages". |
channel |
string | |
contactIdentityId |
guid |
Endpoint
Get the list of Blocked Senders
GET ticketing/blockedSenders
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
emailOrDomain |
string | query | no | Filter by email or domain. |
Response:
An array of Ticketing_BlockedSender
Example
Sample Request:
curl https://api15.comm100.io/v4/ticketing/blockedSenders \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get a single Ticketing_BlockedSender
GET ticketing/blockedSenders/{id}
Example
Sample Request:
curl https://api15.comm100.io/v4/ticketing/blockedSenders/6251ff43-4fcf-44fd-875f-a8dbeff95513 \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Create a new Ticketing_BlockedSender
POST ticketing/blockedSenders
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
identityValueOrDomain |
string | body | yes | Blocked email or domain. |
blockLevel |
string | body | no | How to block a message. Allowed values are "markFutureMessagesAsJunk", "rejectAllFutureMessages". |
channel |
string | body | yes | |
contactIdentityId |
guid | body | no |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/ticketing/blockedSenders \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"identityValueOrDomain":"comm100.com","blockLevel":"rejectAllFutureMessages","channel":"","contactIdentityId":""}'
Response:
HTTP/1.1 201 Created
Update the Ticketing_BlockedSender
PUT ticketing/blockedSenders/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
identityValueOrDomain |
string | body | yes | Blocked email or domain. |
blockLevel |
string | body | no | How to block a message. Allowed values are "markFutureMessagesAsJunk", "rejectAllFutureMessages". |
channel |
string | body | yes | |
contactIdentityId |
guid | body | no |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/ticketing/blockedSenders/6251ff43-4fcf-44fd-875f-a8dbeff95513 \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"identityValueOrDomain":"comm100.com","blockLevel":"rejectAllFutureMessages","channel":"","contactIdentityId":""}'
Response:
HTTP/1.1 200 OK
Remove the Ticketing_BlockedSender
DELETE ticketing/blockedSenders/{id}
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/ticketing/blockedSenders/6251ff43-4fcf-44fd-875f-a8dbeff95513 \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content