Deleting a Test Authorization

Delete a specific test Authorization.

WARNING: This can only be done for test Authorizations (i.e. is_test == true or utility == "DEMO"). This endpoint's main purpose is to allow you to test without filling up your Authorization lists with demos and tests. Non-test Authorizations cannot be deleted (we must keep records of real authorizations). If you want to delete data, use /authorizations/123/revoke, which will forget access credentials and delete all utility data collected (meters, bills, intervals, etc.).

HTTP Request

DELETE https://utilityapi.com/api/v2/authorizations/authorization_uid

Examples

# Delete an Authorization (tests only)
curl -X DELETE -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/authorizations/1234'

DELETE Body

No request body is required.

Response

Returns a Success object.

// Example result
{
    "success": true
}

HTTP Response Codes

Code	Response Format	Description
`200`	Success	Successful request.
`401`	Error	Invalid or missing `access_token`. See our docs on Authentication for how to properly use your `access_token`.
`403`	Error	You are trying to delete a real Authorization. We only allow deleting test Authorizations (i.e. `is_test == true` or `utility == "DEMO"`). If you want to delete data, use /authorizations/123/revoke.
`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).