API
Start typing to search…

Update a resource operation

put
https://{hostname}/api-definitions/v2/endpoints//versions//resources//operations/

Update details about a resource operation. You can change the operation's name, method, purpose, and more.

Path Params
integer
required

Identifies an endpoint.

integer
required

The endpoint's version.

integer
required

Identifies a resource.

string
required
length between 36 and 36

Identifies an operation.

Query Params
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
integer
required

Identifies the API resource.

conditions
array of objects | null

Specify the parameter values to match with.

conditions
failureConditions
array of objects or null | null

Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation type except SEARCH and ADD_TO_CART.

failureConditions
string
enum
required

HTTP method used to call the resource. Choose either HEAD, GET, POST, PUT, DELETE, PATCH, or OPTIONS.

Allowed:
boolean | null

Identifies multifactor authenticated operations. It's valid only for PASSWORD_RESET and LOGIN operations.

string | null

Identifies the multistep group.

string
required
length ≥ 1

The name of the operation. Use the same name you gave to the resource if you only specify one operation.

operationParameter
object | null

Collects data for operation parameters defined when the resource was created.

string
enum
required

The task this operation serves. Choose either LOGIN, ACCOUNT_UPDATE, ACCOUNT_VERIFICATION, ACCOUNT_CREATION, PASSWORD_CHANGE, PASSWORD_RESET, PAYMENT, GIFTCARD_BALANCE_CHECK, LOYALTY_POINTS, SEARCH, or ADD_TO_CART. See Operation purposes for details.

originUserIdCondition
object | null

Collects data for response conditions.

stepSuccessConditions
array of objects or null | null

Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation type except SEARCH and ADD_TO_CART. This is allowed only for operations in a multistep group.

stepSuccessConditions
successConditions
array of objects or null | null

Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation type except SEARCH and ADD_TO_CART.

successConditions
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
Updated about 1 month ago