Delete an Access Role

DELETE /api/v2/roles/{id}.json

Delete an 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

Does not require a payload

Success responses

If the Access Role was deleted successfully you should receive a response with a 204 status code and no body.

Error responses

If the Access Role could not be deleted you may encounter a response with a 400, 403, or 404 status code:

success
A boolean where a value of false means the object could not be deleted.
status
  • 400 may indicate that the ID was not provided, or the object could not be deleted for an unknown reason.
  • 403 indicatse that the Access Role is protected and may not be deleted.
  • 404 indicates that the ID was provided, but the object could not be found.