How it Works
If you have the SMS UBX Sender feature enabled for your Org you will need to use this API to delete an SMS Text to Join Program.
Note: This API is only available for Orgs that have SMS UBX Sender feature enabled.
Use Case
Use this REST API to delete an SMS program when you have the SMS UBX Sender feature enabled for your SMS Org.
Requirements to use this API
- Your Watson Campaign Automation org must have SMS enabled by provisioning and be provisioned to send SMS messages through the UBX Sender feature.
- A database in your Watson Campaign Automation org must have SMS enabled.
- The user making the API call must be enabled for SMS.
- The user making the API call must have valid Oauth credentials.
Note: Up to 10 concurrent requests are allowed to our API servers at any given time when using the OAuth method for authentication.
Endpoint
DELETE /channels/sms/program/{programId}
Parameters
|
Attribute: programId Description: SMS program Id to be deleted, required, string Example: 12345 Notes: ProgramId is provided in the response to a successful Create an SMS Program API call. Alternatively, you can call Get all SMS Programs for an Org API to retrieve a programId. |
Response Codes
| Scenario | Response Code | Message |
| Success | 200 | |
| User is not on an SMS-enabled Org | 403 | Forbidden |
| User calling the API is not SMS enabled | 403 | Forbidden |
| Program ID not found | 404 | Unable to locate SMS program ID {} |
| UBX Sender feature is not enabled for this Org | 405 | Unsupported operation |
Test Your API Call
Use Swagger to test your API call. To access the Swagger environment for your Org, replace {POD#} with the Pod where your Org exists:
https://api{POD#}.silverpop.com/restdoc/#!/channels/delete_sms_program_delete_8
For example, here’s the link to use if your Org is on Pod 1:
https://api1.silverpop.com/restdoc/#!/channels/delete_sms_program_delete_8