restricted_operation — Access denied

Access to the Partner API endpoints is configured for each partner. If the partner is not permitted to access the requested endpoint, the API returns a 403 Forbidden response with the restricted_operation error.

Response format

  • SiteLockOnlineResponse: This element is used to delineate the full API response.

    • error: The error code returned when the partner is not authorized to access the requested endpoint. The value is restricted_operation.

      The restricted_operation error can be returned by any v1 Partner API endpoint when the partner does not have permission to access that endpoint.

    • error_description: A description of the error. The value is This operation is not permitted.

Example error response

<SiteLockOnlineResponse>
    <error>restricted_operation</error>
    <error_description>This operation is not permitted</error_description>
</SiteLockOnlineResponse>