| POST | /integrations |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | body | string | No | The account ID to associate this integration with |
| Type | body | IntegrationTypes | No | The type of integration |
| Name | body | string | No | The name of the integration |
| CustomerId | body | string | No | The parent customer for this integration |
| HostedSuite | |
| OfficeRnd | |
| Zoho |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | string | No | The ID of the account associated with this integration |
| CustomerId | form | string | No | The ID of the customer this integration is associated with |
| CustomerName | form | string | No | The name of the customer this integration is associated with |
| DateLastSync | form | string | No | The date the integration was sync'd last |
| CustomerBreadcrumb | form | List<CustomerBreadcrumb> | No | The breadcrumb to the customer for this integration |
| Name | form | string | No | The name of the integration (e.g. HostedSuite Dallas) |
| AutomaticallyCreateCustomers | form | bool | No | Automatically create new customers / users when sync'ing with CRM? |
| Type | form | IntegrationTypes | No | The type of integration |
| Status | form | IntegrationStatuses | No | The status of the integration |
| StatusMessage | form | string | No | The status of the integration |
| SettingsDataType | form | DataType | No | The settings type for this integration |
| Settings | form | Struct | No | The settings for this integration |
| Features | form | List<IntegrationFeatures> | No | The features supported by this integration |
| IsAuthorized | form | bool | No | Is this integration authorized (OAuth)? |
| 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 |
| NotConfigured | |
| Error | |
| OK |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TypeName | form | string | No | |
| Fields | form | List<DataField> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No | |
| Type | form | ValueTypes | No | |
| UIHint | form | UIHints | No | |
| UITab | form | string | No | |
| IsAsync | form | bool | No | |
| DisableBinding | form | bool | No | |
| StructType | form | DataType | No | |
| ListType | form | DataType | No | |
| Description | form | string | No | |
| PossibleValues | form | List<string> | No | |
| IsOutput | form | bool | No | |
| CustomFieldValuesUrl | form | string | No | |
| DefaultValue | form | Value | No | |
| TransitionNameFormat | form | string | No | |
| Uniqueness | form | DataFieldUniqueness | No | |
| VoiceOnly | form | bool | No | |
| ConditionalVisibilityField | form | string | No | |
| ConditionalVisibilityValue | form | string | No | |
| NoEvalTemplate | form | bool | No | |
| UserMode | form | UserDataFieldModes | No | |
| AnyValueType | form | bool | No |
| NotSpecified | |
| String | |
| Boolean | |
| Number | |
| List | |
| Struct | |
| Transition | |
| Custom | |
| Date | |
| AudioFile | |
| TimeZoneId | |
| PhoneNumber | |
| User | |
| Endpoint | |
| Time | |
| File | |
| FaxNumber | |
| EmailAccount | |
| Customer | |
| Flow | |
| Team | |
| FlowReference | |
| Integration | |
| Assistant |
| None | |
| LargeText | |
| InlineForm | |
| Password | |
| InlineStruct |
| 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 |
| NotUnique | |
| Unique | |
| UniqueToCustomer |
| Hidden | |
| ReadOnly | |
| ReadWrite |
| CrmSync | |
| OAuth2 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /integrations HTTP/1.1
Host: evovoice.io
Accept: application/json
Content-Type: application/json
Content-Length: length
{"accountId":"String","type":"HostedSuite","name":"String","customerId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"accountId":"String","customerId":"String","customerName":"String","dateLastSync":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"name":"String","automaticallyCreateCustomers":false,"type":"HostedSuite","status":"NotConfigured","statusMessage":"String","features":["CrmSync"],"isAuthorized":false,"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}