--- title: "Blocked Sender" slug: "server-api-ticketing-blocked-sender" updated: 2022-06-16T07:11:06Z published: 2022-06-16T07:11:07Z canonical: "developer.comm100.com/server-api-ticketing-blocked-sender" --- > ## Documentation Index > Fetch the complete documentation index at: https://developer.comm100.com/llms.txt > Use this file to discover all available pages before exploring further. # Blocked Sender ## Blocked Sender Block sender,reject or mark as junk message. - `Blocked Senders` - Blocked Senders Manage - `GET ticketing/blockedSenders` - [Get the list of Blocked Senders](/docs/server-api-ticketing-blocked-sender#get-the-list-of-blocked-senders) - `GET ticketing/blockedSenders/{id}` - [Get a single Blocked Sender](/docs/server-api-ticketing-blocked-sender#get-a-single-blocked-sender) - `POST ticketing/blockedSenders` - [Create a new Blocked Sender](/docs/server-api-ticketing-blocked-sender#create-a-new-blocked-sender) - `PUT ticketing/blockedSenders/{id}` - [Update the Blocked Sender](/docs/server-api-ticketing-blocked-sender#update-the-blocked-sender) - `DELETE ticketing/blockedSenders/{id}` - [Remove the Blocked Sender](/docs/server-api-ticketing-blocked-sender#remove-the-blocked-sender) ### Blocked Sender JSON Format Blocked Sender is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of blocked sender. | | `emailOrDomain` | string | Blocked email or domain. | | `blockLevel` | string | How to block a message. Allowed values are "markFutureMessagesAsJunk", "rejectAllFutureMessages". | ### 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 [Blocked Sender](/docs/server-api-ticketing-blocked-sender#blocked-sender-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/ticketing/blockedSenders \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "blockedSenders": [ { "id": "6251ff43-4fcf-44fd-875f-a8dbeff95513", "emailOrDomain": "comm100.com", "blockLevel": "rejectAllFutureMessages" } ], "nextPage": null, "previousPage": null, "total": 1 } ``` ### Get a single Blocked Sender `GET ticketing/blockedSenders/{id}` - #### Parameters: No Parameters - #### Response: [Blocked Sender](/docs/server-api-ticketing-blocked-sender#blocked-sender-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/ticketing/blockedSenders/6251ff43-4fcf-44fd-875f-a8dbeff95513 \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "id": "6251ff43-4fcf-44fd-875f-a8dbeff95513", "emailOrDomain": "comm100.com", "blockLevel": "rejectAllFutureMessages" } ``` ### Create a new Blocked Sender `POST ticketing/blockedSenders` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `emailOrDomain` | string | body | yes | Blocked email or domain. | | `blockLevel` | string | body | no | How to block a message. Allowed values are "markFutureMessagesAsJunk", "rejectAllFutureMessages". | - #### Response: [Blocked Sender](/docs/server-api-ticketing-blocked-sender#blocked-sender-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/ticketing/blockedSenders \ -X 'POST' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"emailOrDomain":"comm100.com","blockLevel":"rejectAllFutureMessages"}' ``` Response: HTTP/1.1 201 Created ``` { "id": "6251ff43-4fcf-44fd-875f-a8dbeff95513", "emailOrDomain": "comm100.com", "blockLevel": "rejectAllFutureMessages" } ``` ### Update the Blocked Sender `PUT ticketing/blockedSenders/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `emailOrDomain` | string | body | yes | Blocked email or domain. | | `blockLevel` | string | body | no | How to block a message. Allowed values are "markFutureMessagesAsJunk", "rejectAllFutureMessages". | - #### Response: [Blocked Sender](/docs/server-api-ticketing-blocked-sender#blocked-sender-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/ticketing/blockedSenders/6251ff43-4fcf-44fd-875f-a8dbeff95513 \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"emailOrDomain":"comm100.com","blockLevel":"rejectAllFutureMessages"}' ``` Response: HTTP/1.1 200 OK ``` { "id": "6251ff43-4fcf-44fd-875f-a8dbeff95513", "emailOrDomain": "comm100.com", "blockLevel": "rejectAllFutureMessages" } ``` ### Remove the Blocked Sender `DELETE ticketing/blockedSenders/{id}` - #### Parameters: No Parameters - #### Response: No Content - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/ticketing/blockedSenders/6251ff43-4fcf-44fd-875f-a8dbeff95513 \ -X 'DELETE' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 204 No Content