Update a multistep group

put

https://{hostname}/api-definitions/v2/endpoints/{endpointId}/versions/{versionNumber}/multistep-groups/{multistepGroupId}

Change the multistep group's name. To assign an operation to a multistep group, modify its 'multistepGroupId' value. You can only add any given operation to a single group.

Path Params

endpointId

integer

required

Identifies an endpoint.

versionNumber

integer

required

The endpoint's version.

multistepGroupId

string

required

length between 36 and 36

Identifies a multistep group. You must set this value to add an operation to a multistep group. Allowed only for the following operation types: LOGIN, ACCOUNT_VERIFICATION, ACCOUNT_CREATION, PASSWORD_RESET and PAYMENT.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Add information about your multistep group.

name

string

required

length ≥ 1

The name of the multistep group.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Successful response.

400Bad request. The request body has invalid fields.

403Forbidden. You don't have permission to access the resource.

404Not found. The requested resource operation doesn't exist.