Update Program

put

https://api.firstorion.com/exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}

Update the properties of a program.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

businessId

string

required

System generated unique identifier for the business

businessUnitId

string

required

System generated unique identifier for the business unit.

programId

string

required

System generated unique identifier for the program

Body Params

programName

string

2 to 256

User defined name of a branded communications program

active

boolean

Defaults to null

Disable / enable branding for the program. NOTE: This is a placeholder, and the functionality has not been implemented yet.

callPurposeCode

string

The most common purpose why the phone number is making calls. Must be one of GET /exchange/v1/reference-data/call-purposes

dailyCallCountEstimateRangeId

integer

A user provided estimate how many phone calls will be made under this program on daily basis. Value must match one of the ranges listed with GET /exchange/v1/reference-data/daily-call-count-ranges

authenticatedCalls

boolean

Defaults to false

Will the program be used for Authenticated/Verified calls. NOTE: Authenticated/Verified calls refer to the functionality where a client sends a pre-call event for each phone call that will be made.

Headers

Authorization

string

required

Responses

401

Unauthorized

403

Forbidden

200OK

400Bad Request

404Not Found

409Conflict