RolePoint API Documentation

Schema

All API access is over HTTPS, and accessed from the external.rolepoint.com domain. All data is sent and received as JSON, and should include the header content-type: application/json.

Authentication

All requests must be issued with Basic Authentication parameters.

$ curl -u username:password https://external.rolepoint.com

Permissions

If a request is made for which you do not have sufficient permissions a 401 Unauthorized response will be returned. An example of this would be attempting to PATCH fields you do not have permission to. In this case NO fields would be updated, and a 401 Unauthorized response would be returned.

Responses

We issue the following response codes:

• HTTP/1.1 200 OK - The request was completed successfully.
• HTTP/1.1 401 Unauthorized - Either your credentials were incorrect or you do not have the required permissions.
• HTTP/1.1 404 Not Found - The respource you requested was not found.
• HTTP/1.1 500 Internal Server Error - Unknown error.

PATCH Responses

When issuing a PATCH request the response will be JSON containing the updated fields and their new values.

Example Request

HTTP/1.1 PATCH /v3/referrals/123
content-type: application/json

{
    "application_status": "new"
}

Example Response

HTTP/1.1 200 OK
content-type: application/json

{
    "application_status": "new"
}