Overview
This section details a sequence of API requests to quickly create all the necessary elements to initiate an INFORM Program.
Included Endpoints
| Step | Endpoint | Path Parameters |
|---|---|---|
| Request Authentication Token | v1/auth | |
| Register Business | exchange/v1/businesses | |
| Check Business Registration Status | exchange/v1/businesses/{businessId} | businessId |
| Add Business Unit | exchange/v1/businesses/{businessId}/business-units | businessId |
| Create Program | exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs | businessId businessUnitId |
| Create New CallerName Delivery Channel | exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}/delivery-channels/callerName | businessId businessUnitId programID deliveryChannelType (callerName) |
| Create New Program Schedule | exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}/schedules | businessId businessUnitId programID |
| Add New CallerName aNumber | exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}/delivery-channels/callerName/a-numbers | businessId businessUnitId programID deliveryChannelType (callerName) |
| Optional: Pre-Call Program Content Prep | exchange/v1/calls/push |
API Call Sequence Diagram
The Following sequence diagram details the API requests necessary, and in what order, to register your business and start branding your calls after you've had your business approved.
Sequence Diagram to Register a Business and Brand Calls once it is Approved
Now check out the API Reference Page and plug in your own variables!
