Error codes

Last updated June 17th, 2026

Tag API uses conventional HTTP response codes to indicate success or failure of a request. This document describes the standard HTTP response codes and Tag API-specific error codes.

Error object

Each error response contains a JSON body with additional information about the error:

Property	Type	Description
`result`	Integer	HTTP status code
`code`	String	Application-specific error code
`message`	String	Error message name
`data`	String	Detailed error description

Following is an example 400 response:

{
    "result": 400,
    "code": "4000000",
    "message": "RESOURCE_INVALID_PARAM",
    "data": "The specified request parameters are not valid."
}

Standard HTTP responses

The following table lists relevant HTTP responses for Tag API:

HTTP status	Name	Description
200	Success	The request was successfully processed
201	Created	The request was successful and a resource was created
204	No Content	The request was successful but there is no content to return
400	Bad Request	The client has issued an invalid request
401	Unauthorized	Authorization is required but not provided
403	Forbidden	Insufficient permissions to access this resource
404	Not Found	The requested path or resource does not exist
500	Server Error	An error has occurred on the server

Tag API error codes

Tag API specifies the following custom error codes that provide more information than standard HTTP response codes:

`code`	`message`	`data`
4000000	RESOURCE_INVALID_PARAM	The specified request parameters are not valid
4000001	MISSING_REQUIRED_PARAM	A required parameter is missing
40100000	AUTHORIZATION_FAIL	Missing or invalid authorization header
40300000	FORBIDDEN_ACCESS	Access denied due to insufficient permissions
4040000	RESOURCE_NOT_FOUND	The requested resource does not exist
50000000	INTERNAL_SERVER_ERROR	An unexpected error occurred

Diagnosing common errors

If your request returns a 4xx error

Check the specific error code and update your request parameters accordingly. Common causes include:

Missing required parameters (e.g., customerId, deviceIds)
Invalid parameter formats (e.g., invalid UUID format for tagId)
Parameter values outside allowed ranges (e.g., pageSize must be between 1 and 100)

If your request returns a 401 or 403 error

Verify your authentication:

Ensure your access token is valid and has not expired
Check that the Authorization header is formatted correctly: Bearer {ACCESS_TOKEN}
Verify your application has the required scopes (tag, tag.tags:view, or tag.tags:manage)

If your request returns a 404 error

Check that the resource exists:

Verify the tagId or customerId is correct
Ensure you have access to the Tag API

If your request returns a 5xx error

Please try the request again at a later time. If the issue persists, create a support ticket.