Requires any of the roles: | SystemAdministrator, Manager, Customer |
POST | /customers/{customerId}/staging |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | string | No | The ID of the customer you want to update |
IsStaging | body | bool | No | Should this customer's phone numbers route to the staging server |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AccountId | form | string | No | The ID of the account associated with this customer |
ParentCustomerId | form | string | No | The parent customer ID for this customer |
Breadcrumb | form | List<CustomerBreadcrumb> | No | The breadcrumb to this customer |
AccountName | form | string | No | The name of the account associated with this customer |
IsStaging | form | bool | No | Is this customer staging or production? |
Name | form | string | No | The name of the company |
ReferenceId | form | string | No | The reference ID for this company |
Data | form | Struct | No | This customer's data values |
Tags | form | List<Tag> | No | The list of tags for this customer |
Schedule | form | Schedule | No | This customer's schedule |
IntegrationData | form | EntityIntegrationData | No | Integration data for this customer |
OverrideBillingSettings | form | bool | No | Override this customer's billing settings? Otherwise inherits from parent |
BillingSettings | form | BillingSettings | No | Billing settings for this customer |
OverrideAppSettings | form | bool | No | Should this customer override the parent customer's app settings |
AppSettings | form | AppSettings | No | App / Portal settings for this customer |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | The ID of the object |
DateCreated | form | string | No | The date the object was created |
DateLastModified | form | string | No | The date the object was last modified |
CreatedBy | form | string | No | The user that created this object |
LastModifiedBy | form | string | No | The user that last modified this object |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BoolValue | form | bool? | No | |
StringValue | form | string | No | |
NumberValue | form | double? | No | |
ListValue | form | List<Struct> | No | |
StructValue | form | Struct | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
Color | form | TagColors | No |
Magenta | |
Red | |
Volcano | |
Orange | |
Gold | |
Lime | |
Green | |
Cyan | |
Blue | |
GeekBlue | |
Purple |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TimeZoneId | form | string | No | |
Inherit | form | bool | No | |
ForceClosed | form | bool | No | |
Rules | form | List<SchedulingRule> | No | |
DefaultState | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
Priority | form | int | No | |
State | form | string | No | |
Source | form | string | No | |
Condition | form | string | No | |
SimpleRuleType | form | SimpleSchedulingRuleTypes | No | |
CustomerState | form | string | No | |
FlowId | form | string | No | |
FlowParams | form | Struct | No | |
IsAllDay | form | bool | No | |
StartDate | form | string | No | |
StartTime | form | string | No | |
EndTime | form | string | No | |
BySetPosition | form | List<int> | No | |
ByMonth | form | List<int> | No | |
ByWeekNo | form | List<int> | No | |
ByYearDay | form | List<int> | No | |
ByMonthDay | form | List<int> | No | |
ByDay | form | List<ScheduleDay> | No | |
ByHour | form | List<int> | No | |
ByMinute | form | List<int> | No | |
Interval | form | int | No | |
Count | form | int | No | |
UntilDate | form | string | No | |
Frequency | form | SchedulingRuleFrequency | No |
Always | |
CustomerState | |
Time |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
DayOfWeek | form | DayOfWeek | No |
None | |
Secondly | |
Minutely | |
Hourly | |
Daily | |
Weekly | |
Monthly | |
Yearly |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ThirdPartyId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Base | form | BillingItem | No | |
LocalNumbers | form | BillingItem | No | |
TollFreeNumbers | form | BillingItem | No | |
InboundVoiceCalls | form | BillingItem | No | |
OutboundVoiceCalls | form | BillingItem | No | |
InboundFaxes | form | BillingItem | No | |
OutboundFaxes | form | BillingItem | No | |
InboundSmsMessages | form | BillingItem | No | |
OutboundSmsMessages | form | BillingItem | No | |
AIInsights | form | BillingItem | No | |
AILiveMinutes | form | BillingItem | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BaseCost | form | double | No | |
RawUnitMultiplier | form | double | No | |
UnitCost | form | double | No | |
Allowance | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EnablePhoneNumberManagement | form | bool | No | |
EnableDeviceManagement | form | bool | No | |
EnableDialer | form | bool | No | |
EnableCallHistory | form | bool | No | |
EnableAssistants | form | bool | No | |
ShowFileNameInMessageCenter | form | bool | No | |
ChakraTheme | form | string | No | |
CustomCss | form | string | No | |
PageTitle | form | string | No | |
StringMappings | form | string | No | |
LogoutUrl | form | string | No | |
PortMyNumberUrl | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers/{customerId}/staging HTTP/1.1
Host: team.evovoice.io
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"customerId":"String","isStaging":false}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"accountId":"String","parentCustomerId":"String","breadcrumb":[{"id":"String","name":"String"}],"accountName":"String","isStaging":false,"name":"String","referenceId":"String","tags":[{"id":"String","name":"String","color":"Magenta"}],"schedule":{"timeZoneId":"String","inherit":false,"forceClosed":false,"rules":[{"id":"String","name":"String","priority":0,"state":"String","source":"String","condition":"String","simpleRuleType":"Always","customerState":"String","flowId":"String","isAllDay":false,"startDate":"String","startTime":"String","endTime":"String","bySetPosition":[0],"byMonth":[0],"byWeekNo":[0],"byYearDay":[0],"byMonthDay":[0],"byDay":[{"offset":0,"dayOfWeek":"Sunday"}],"byHour":[0],"byMinute":[0],"interval":0,"count":0,"untilDate":"String","frequency":"None"}],"defaultState":"String"},"integrationData":{"String":{"thirdPartyId":"String"}},"overrideBillingSettings":false,"billingSettings":{"base":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"localNumbers":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"tollFreeNumbers":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundVoiceCalls":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundVoiceCalls":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundFaxes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundFaxes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundSmsMessages":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundSmsMessages":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"aiInsights":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"aiLiveMinutes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0}},"overrideAppSettings":false,"appSettings":{"enablePhoneNumberManagement":false,"enableDeviceManagement":false,"enableDialer":false,"enableCallHistory":false,"enableAssistants":false,"showFileNameInMessageCenter":false,"chakraTheme":"String","customCss":"String","pageTitle":"String","stringMappings":"String","logoutUrl":"String","portMyNumberUrl":"String"},"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}