Unsubscribe
Version 1 of the UnsubscribeController
| API | Description |
|---|---|
| GET api/v1/Unsubscribe/{senderId}/{sinceDate} |
No documentation available. |
Message
Version 1 of the MessageController.
| API | Description |
|---|---|
| POST api/v1/Message |
Create and send a message to one individual. This should be used for emails that need to be sent immediately and cannot wait to be picked up on a schedule (i.e. password resets, email confirmations, etc.) |
CampaignRecipient
Version 1 of the CampaignRecipientController.
| API | Description |
|---|---|
| GET api/v1/CampaignRecipient/{id} |
Retrieves the details of the CampaignRecipient using the provided id |
| GET api/v1/CampaignRecipient/{campaignId}/{entityNameId}/{entityId} |
Retrieves the details of the CampaignRecipient using the CampaignId generated by Switchboard and the EntityNameId and EntityID passed in when creating the campaign. |
Campaign
Version 1 of the CampaignController.
| API | Description |
|---|---|
| PATCH api/v1/Campaign/{id}/cancel |
Cancels a campaign that has not been started yet. |
| POST api/v1/Campaign |
Creates a campaign to send a message to the included list of recipients. Campaigns are generally used to send the same message to multiple people and are picked up on a scheduled basis. |
| GET api/v1/Campaign/{id} |
Retrieves the details of the Campaign using the provided id |
| PATCH api/v1/Campaign/{id}/retry |
Retries any failed recipients from a previously run campaign. |
Chatbot
| API | Description |
|---|---|
| GET api/Chatbot/Generate?contract={contract}&environment={environment} |
No documentation available. |
| GET api/Chatbot/Refresh?contract={contract}&environment={environment}&token={token} |
No documentation available. |
Twilio
A controller for receiving calls from the Twilio SMS provider.
| API | Description |
|---|---|
| POST api/Twilio/IncomingSMSMessage |
An endpoint used by Twilio to relay information about incoming text messages on our phone numbers. |
| POST api/Twilio/Status |
An endpoint used by Twilio to relay information about events that happened in the Twilio system. |
SendGrid
A controller for receiving calls from the SendGrid email provider.
| API | Description |
|---|---|
| POST api/SendGrid/Events |
An endpoint used by SendGrid to relay information about events that happened in the SendGrid system. |