Update an Access Role
PUT
/api/v2/roles/{id}.json
Update an existing Access Role by its ID.
Scope
Requires the roles OAuth scope.
Parameters
Your request must provide the following URL parameters:
id
required
The ID of your Access Role object |
Request body
Your request body must contain an object including:
data
required
Containing updates to your Access Role object. |
Example JSON request
To update an Access Role you must PUT JSON to this resource within a data object.
You do not need to supply all properties and may choose to only supply properties that require modifying.
Note, changing the title of your Access Role, this will NOT auto-generate a new
reference.
{
"data": {
"title": "Trade Partner"
}
}
Success responses
If the Access Role was updated successfully you should receive a response with a 200 status
code:
success
A boolean where a value of true means the object was saved successfully.
|
status
The HTTP status code e.g. 200 means the object was updated successfully. |
data
Contains the Access Role object you updated. |
Error responses
If the Access Role could not be updated you will encounter a response with either a
400,
403,
404 or
422status code:
success
A boolean where a value of false means the object could not be updated.
|
status
|
context
|
errors
Contains an array of error objects, each will have the following properties:
|