PUT v1/application/button-type/{id}

Use this method to update an existing button type.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Button type unique identifier.

 string

Required

Body Parameters

Button type data to be updated.

ButtonType
NameDescriptionTypeAdditional 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

Sample: 
{
  "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 HTTP headers with appropriate information as to the result of the update operation. In the body, returns a boolean value (true/false) where true means the operation did update the record, or false if the record did needed to be updated for example, when all fields match.

boolean

Response Formats

application/json, text/json

Sample: 
true