Unyte - Developer Documentation

Unyte API calls provides a set of responses that can be used to communicate with the client. The responses are based on the HTTP status codes and are used to indicate the success or failure of an operation. Most calls would return JSON response bodies that include information about the resource, and may include one or more contextual HATEOAS links. Use these links to request more information about and construct an API flow that is relative to a specific request. Each REST API request returns an HTTP status code.

HTTP Status Codes

Successful requests

Unyte returns HTTP status codes in the 2xx range for successful requests. The following table lists the HTTP status codes that are returned for successful requests.

Status Code	Description
`200 OK`	The API request succeeded.
`201 Created`	A `POST` request was successful and a new resource was created.
`202 Accepted`	The request has been accepted for processing, but the processing has not been completed. This means the server would excute it later.
`204 No Content`	The server successfully executed the request but there is no content to return.

Failed requests

HTTP 4XX status codes

For failed requests, the platform would return HTTP status codes in the 4xx and 5xx range. This could be something was wrong with the request as in 4xx or something on our end wrong with a server or service, 5xx. The following table lists the HTTP status codes that are returned for failed requests. For authentication specific HTTP 4XX status codes, refer to the Authorization errors section.

Status Code	Description	Probable Cause and Solutions
`400 Bad Request`	`INVALID_REQUEST`. The request was invalid or cannot be served. This could be because the request was syntatically incorect, or violates the schema.	Check the request for validation errors - missing or incorrect parameters, or incorrect data types. The server couldn’t uderstand the request, indicating in addition to the things stated before, one of the followng below:
		- The data is not in the expected format
		- A data validation error occured
		- The API cannot convert the payload data to the underlying data type
`404 Not Found`	`RESOURCE_NOT_FOUND`. The requested resource does not exist	The server couldn’t find anything on the requested resource. This could be either, because the URI does not exists or the resource is not available. For example, was it previoulsy deleted in a seperate request? or perharps does not exist yet in our database.
`405 Method Not Allowed`	`METHOD_NOT_SUPPORTED`. The server does not implement the requested HTTP method	The server does not support the HTTP request method, e.g `PATCH` or `DELETE` operations in some cases
`406 Not Acceptable`	`MEDIA_TYPE_NOT_SUPPORTED`. The server does not support the media type that is acceptable by the client
`409 Conflict`	`RESOURCE_CONFLICT`. The request could not be processed because it conflicts with another request	Perhaps, a similar request is previously running? The server could not complete the requested action as it conflicts with aother requets that is currently being processed. Please retry the request later.
`429 Too Many Requests`	`RATE_LIMIT_REACHED`. Too many requests - Blocked due to rate limiting.	The rate limit for the user or application has exceed a predefined value. Please consult with customer support.

HTTP 5XX status codes

Status code	Description	Possible causes and solutions
`500 Internal Server Error`	`INTERNAL_SERVER_ERROR`. An internal server error has occured	A system or application error has occured. Please note the although, the client may have provided a correct request, something unexpected occured within our internal systems. Please try again or reach out to support team
`503 Service Unavailable`	`SERVICE_UNAVAILABLE`. Temporary outage or failure of a service	The server couldn’t handle the incoming request due to a temporary downtime of one of our service, or system scheduled for maintainance. Please check with the support team or the review operational APIs through the `Status` page

Authorization errors

The following table lists common authorization-related errors you might encounter. These errors typically correspond to HTTP 401 Unauthorized or 403 Forbidden status codes.

Status Code	Error Code (in response body)	Description	Probable Cause and Solutions
`401 Unauthorized`	`UNAUTHORIZED`	The request requires user authentication. The credentials provided are missing or invalid.	Cause: Missing or incorrect API key, token, or other authentication method. Solution: Ensure your request includes valid authentication credentials and that they are correctly formatted (e.g., in the `Authorization` header).
`403 Forbidden`	`FORBIDDEN` or `PERMISSION_DENIED`	The server understood the request, but refuses to authorize it. The authenticated user does not have the necessary permissions to access the resource or perform the requested action.	Cause: The user associated with the provided credentials does not have the required role or permissions for this specific operation or resource. Solution: Verify that the user’s role and permissions allow them to perform the action. Contact an administrator if necessary to adjust permissions.

HATEOAS links

Coming soon

Get Started

REST APIs

Core Resources

Sandbox

Going Live

Responses

HTTP Status Codes

Successful requests

Failed requests

HTTP 4XX status codes

HTTP 5XX status codes

Authorization errors

HATEOAS links

​HTTP Status Codes

​Successful requests

​Failed requests

​HTTP 4XX status codes

​HTTP 5XX status codes

​Authorization errors

​HATEOAS links

HTTP Status Codes

Successful requests

Failed requests

HTTP 4XX status codes

HTTP 5XX status codes

Authorization errors

HATEOAS links