Create Commando Mode transition - Marqeta Docs

POST//

Create a Commando Mode transition. A Commando Mode transition enables/disables a given Commando Mode control set. You must have an existing Commando Mode control set to enable/disable Commando Mode.

Body field details

Fields	Description
token string Optional	The unique identifier of the Commando Mode transition. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 36 char max
commando_mode_token string Required	The unique identifier of the Commando Mode control set to transition. Allowable Values: Existing Commando Mode token.
transition object Required	Determines the state of the associated Commando Mode control set. Allowable Values: Existing `transition` object.

The transition object

Fields	Description
commando_enabled boolean Required	Indicates whether Commando Mode is enabled. Allowable Values: `true`, `false`
reason string Optional	Describes the reason the current state of the Commando Mode control set was changed. Allowable Values: 512 char max Default value: `null`
channel string Required	The mechanism that changed the Commando Mode control set’s state. Allowable Values: `API`, `SYSTEM`, `ADMIN`
user_name string Optional	Identifies the user who changed the Commando Mode control set’s state. Allowable Values: 256 char max Default value: `null`

Sample request body

JSON

{
  "token": "commando_mode_1_transition",
  "commando_mode_token": "commando_mode_1",
  "transition": {
    "commando_enabled": "true",
    "reason": "Lost connection",
    "channel": "API",
    "user_name": "Bob"
  }
}

Sample response body

JSON

{
  "token": "commando_mode_1_transition",
  "commando_mode_token": "commando_mode_1",
  "transition": {
    "commando_enabled": "true",
    "reason": "Lost connection",
    "channel": "API",
    "user_name": "Bob"
  },
  "created_time": "2021-02-14T18:48:10Z"
}