# SuprSend API API

> SuprSend API API on Apizie: 26 endpoints (Fetch Template List, Fetch Template details, Fetch Template content for a channel, Get Brand data, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/communication:suprsend/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:suprsend`
- Category: Communication
- Status: byok
- Source: https://suprsend.com
- Page: https://www.apizie.tech/api/communication/suprsend
- OpenAPI: https://www.apizie.tech/api/communication/suprsend/openapi.json

SuprSend is a central communication stack for easily creating, managing and delivering notifications to your end users on multiple channels. Our single notification API has all the features set, which enables you to…

## Endpoints

### Fetch Template List
`GET https://www.apizie.tech/v1/communication:suprsend/template-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| has_tag_ids_any | string | no | comma separated string of tag ids attached to the template |
| has_channels_any | string | no | comma separated string of channels. Returns templates which has any of the channels present from the channel string. Use these keys for… |
| is_active | boolean | no | Set `true` for published templates, `false` for templates which are in draft. Do not pass this key to return all templates. |
| is_archived | boolean | no | Set `true` to get archived templates, default = `false` |

### Fetch Template details
`GET https://www.apizie.tech/v1/communication:suprsend/template-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| template_slug | string | yes | Template group slug you want to fetch content details. You'll get the template slug by clicking on copy button next to template group name… |

### Fetch Template content for a channel
`GET https://www.apizie.tech/v1/communication:suprsend/template-get-content-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| template_slug | string | yes | Template group slug you want to fetch content details. You'll get the template slug by clicking on copy button next to template group name… |
| channel_slug | string | yes | add one of the template channels - `email`, `sms`, `whatsapp`, `inbox`, `slack`, `androidpush`, `iospush`, `webpush` |

### Get Brand data
`GET https://www.apizie.tech/v1/communication:suprsend/brand-brand-data-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brand_id | string | yes | unique identifier of the brand you want to get the details for |

### Create / Update Brands
`POST https://www.apizie.tech/v1/communication:suprsend/brand-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brand_id | string | yes | unique identifier of the brand that you want to create / update |
| Content - Type | string | no |  |
| body | object | no | JSON request body |

### Update User Preferences (Category level)
`POST https://www.apizie.tech/v1/communication:suprsend/subscriber-update-user-preferences-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| distinct_id | string | yes | distinct_id of the user whose preferences should be fetched |
| tenant_id | string | no | to fetch user preferences for a particular brand |
| category_slug | string | yes | notification category slug. You can get this from Notification Categories page on SuprSend dashboard -> Settings page |
| body | object | no | JSON request body |

### Add Subscribers to List
`POST https://www.apizie.tech/v1/communication:suprsend/subscriber-add-to-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | string | yes | Unique string idenitifier of the list to which user needs to be updated |
| body | object | no | JSON request body |

### Remove Subscribers from List
`POST https://www.apizie.tech/v1/communication:suprsend/subscriber-list-remove-subscribers-from-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | string | yes | Unique string idenitifier of the list to which user needs to be updated |
| body | object | no | JSON request body |

### Delete List
`POST https://www.apizie.tech/v1/communication:suprsend/subscriber-list-delete-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | string | yes | Unique string idenitifier of the list which you want to delete |

### Delete Draft List
`POST https://www.apizie.tech/v1/communication:suprsend/subscriber-delete-draft-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | string | yes | Unique string idenitifier of the list which you want to delete |
| version_id | string | yes | Unique identifier of the draft version of the list which needs to be deleted |

### Start Sync
`POST https://www.apizie.tech/v1/communication:suprsend/sync-list-start-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | string | yes | Unique identifier of the list on which the sync needs to start to create a draft version |

### Add Subscribers to Draft List
`POST https://www.apizie.tech/v1/communication:suprsend/subscriber-add-to-draft-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | string | yes | Unique string idenitifier of the list to which user needs to be updated |
| version_id | string | yes | Unique string idenitifier of the draft version of the list to which user needs to be updated |
| body | object | no | JSON request body |

### Remove Subscribers from Draft List
`POST https://www.apizie.tech/v1/communication:suprsend/subscriber-remove-from-draft-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | string | yes | Unique string idenitifier of the list to which user needs to be updated |
| version_id | string | yes | Unique string idenitifier of the draft version of the list to which user needs to be updated |
| body | object | no | JSON request body |

### Finish Sync
`POST https://www.apizie.tech/v1/communication:suprsend/subscriber-finish-sync-draft-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | string | yes | Unique string idenitifier of the list |
| version_id | string | yes | Unique string idenitifier of the draft version of the list which needs to be made active(live) |

### Trigger Broadcast
`POST https://www.apizie.tech/v1/communication:suprsend/broadcast-trigger-message-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_key | string | yes |  |
| body | object | no | JSON request body |

### Trigger an Event
`POST https://www.apizie.tech/v1/communication:suprsend/event-trigger-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Trigger Workflow
`POST https://www.apizie.tech/v1/communication:suprsend/workflow-configure-trigger` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_key | string | yes |  |
| body | object | no | JSON request body |

### Get Brand list
`GET https://www.apizie.tech/v1/communication:suprsend/brand-list-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | number of results to be returned in API response |
| offset | string | no | starting position of brand list |

### Get User Preferences (Channel level)
`GET https://www.apizie.tech/v1/communication:suprsend/preference-get-user-channel-preferences` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| distinct_id | string | yes | distinct_id of the user whose preferences should be fetched |
| tenant_id | string | no | to fetch user preferences for a particular brand |

### Update User Preferences (Channel level)
`POST https://www.apizie.tech/v1/communication:suprsend/preference-update-channel-preferences` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| distinct_id | string | yes | distinct_id of the user whose preferences should be fetched |
| tenant_id | string | no | to fetch user preferences for a particular brand |
| body | object | no | JSON request body |

### Get User Preferences (All Categories)
`GET https://www.apizie.tech/v1/communication:suprsend/pref-category-get-user-preferences-all-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| distinct_id | string | yes | distinct_id of the user whose preferences should be fetched |
| tenant_id | string | no | to fetch user preferences for a particular brand |

### Update Brand Default Preference
`POST https://www.apizie.tech/v1/communication:suprsend/brand-update-default-preference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brand_id | string | yes | unique identifier of the brand you want to update default preferences for |
| category_slug | string | yes | notification category slug. You can get this from Notification Categories page on SuprSend dashboard -> Settings page |
| body | object | no | JSON request body |

### Get Brand Default Preference
`GET https://www.apizie.tech/v1/communication:suprsend/brand-get-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| brand_id | string | yes | unique identifier of the brand you want to get default preferences for |

### Get all Lists
`GET https://www.apizie.tech/v1/communication:suprsend/subscriber-list-get-all-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | number of results to be returned in API response |
| offset | string | no | starting position of brand list |

### Create a List
`POST https://www.apizie.tech/v1/communication:suprsend/subscriber-list-create-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get List data
`GET https://www.apizie.tech/v1/communication:suprsend/subscriber-list-get-list-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | string | yes | Unique string idenitifier of the list. |

## Example
```
curl "https://www.apizie.tech/v1/communication:suprsend/template-get-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the SuprSend API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/communication:suprsend/template-get-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the SuprSend API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. SuprSend API itself also needs your own key from hub.suprsend.com.

### Can AI agents use the SuprSend API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key communication:suprsend.

### What is the status of the SuprSend API API?
Needs your own provider key (bring your own key)