Modifying Authorizations

NOTE: Only some Authorization fields are editable. See below for a list of editable fields.

HTTP Request

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

Examples

# Archive an Authorization
curl -X PATCH -H 'Authorization: Bearer API_TOKEN_HERE' \
    -d '{"is_archived": true}' \
    'https://utilityapi.com/api/v2/authorizations/1234'

PATCH Body

The request body must be a valid JSON object. Below are the parameters that can be updated. If a parameter isn't included in the request body, it isn't changed.

Parameter	Format	Description	Example
`is_archived`	Boolean	Set the archive state of the Authorization.	`true`
`nickname`	String or `null`	A nickname for this authorization. Can be set to any valid unicode string or to `null` to remove the nickname altogether.	`"Vance Refrigeration Main Office"`

NOTICE: Archiving an authorization will not stop any active ongoing monitoring subscriptions and you may continue to be charged for them. To stop monitoring meters, see the documentation for ongoing monitoring .

Response

Returns the updated Authorization object.

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

HTTP Response Codes

Code	Response Format	Description
`200`	Authorization	Successful request.
`400`	Error	The PATCH parameters are malformed. Check the `error` in the response for the type of error: `invalid_param` We may add more error types in the future, so be able to handle unknown types.
`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).