Revoking an Authorization

Revoke a specific Authorization. The earliest revocation will appear as the Authorization revoked timestamp.

WARNING: This cannot be undone! This forgets access credentials, clears customer data from all meters, and deletes all bills and intervals associated with the Authorization.

HTTP Request

POST https://utilityapi.com/api/v2/authorizations/authorization_uid/revoke

Examples

# Revoke an Authorization (CANNOT BE UNDONE!)
curl -X POST -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/authorizations/1234/revoke'

POST Body

No request body is required.

Response

Returns the revoked Authorization object.

// Example returned Authorization
{
    "uid": "12345",
    "created": "2016-01-01T12:30:24.653422+00:00",
    ...
}

HTTP Response Codes

Code	Response Format	Description
`200`	Authorization	Successful request.
`401`	Error	Invalid or missing `access_token`. See our docs on Authentication for how to properly use your `access_token`.
`404`	Error	This Authorization doesn't exist or you don't have permissions to see it.
`429`	N/A	The request was rate limited. Check the `Retry-After` response header for how long to wait until retrying the request. Do not expect any specific response format for this error (could be html, json, or nothing).
`500`	N/A	Internal server error. Do not expect any specific response format for this error (could be html, json, or nothing). This error is logged and will be fixed by our engineers.
`503`	N/A	Site is currently down for maintenance. Do not expect any specific response format for this error (could be html, json, or nothing).
`504`	N/A	We tried to build this request but timed out. Please try again later. Do not expect any specific response format for this error (could be html, json, or nothing).