Getting Started with Branded Communication APIs

Overview

This section details a sequence of API requests to quickly create all the necessary elements to initiate an INFORM Program.

Use the recipe walkthrough below to get started. Also, see the table and diagram to learn about the requests included in this process.

Included Endpoints

StepEndpointParameters
Request Authentication Token/v1/auth
Register Business/exchange/v1/businesses
Create Business Unit/exchange/v1/businesses/{businessId}/business-unitsbusinessId
Create New Program/exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programsbusinessId and businessUnitID
Add New CallerName Numbers to Program/exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}/delivery-channels/callerName/a-numbersbusinessId, businessUnitId, and programId

API Request Diagram between Client and First OrionAPI Request Diagram between Client and First Orion

API Request Diagram between Client and First Orion