POST v1/application/{environment}/{orgId}/{appId}/button-type
Use this method to create a new button type for an application. Button types are global to the application.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| environment |
Environment where the org originated from. |
string |
Required |
| orgId |
Organization Id |
integer |
Required |
| appId |
Application Id |
integer |
Required |
Body Parameters
Button type structure containing the data for the new button type.
ButtonType| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The button type unique identifier. Null if the button type is a template for creating button types. |
string |
None. |
| type |
The most important value, and what the client sdks evaluate to identify a button type |
integer |
None. |
| internalName |
The internal name is used through logical paths to identify certain features needed to be shown/hidden. Is not required but very important that a button type is given an internal name. |
string |
None. |
| name |
User friendly button type display name. |
string |
None. |
| platforms | Collection of string |
None. |
Request Formats
application/json, text/json
{
"id": "sample string 1",
"type": 2,
"internalName": "sample string 3",
"name": "sample string 4",
"platforms": [
"sample string 1",
"sample string 2"
]
}
Response Information
Resource Description
Returns the button type created along with its new id. If an error or validation prevents the button type from been created.
ButtonType| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The button type unique identifier. Null if the button type is a template for creating button types. |
string |
None. |
| type |
The most important value, and what the client sdks evaluate to identify a button type |
integer |
None. |
| internalName |
The internal name is used through logical paths to identify certain features needed to be shown/hidden. Is not required but very important that a button type is given an internal name. |
string |
None. |
| name |
User friendly button type display name. |
string |
None. |
| platforms | Collection of string |
None. |
Response Formats
application/json, text/json
{
"id": "sample string 1",
"type": 2,
"internalName": "sample string 3",
"name": "sample string 4",
"platforms": [
"sample string 1",
"sample string 2"
]
}