Use this endpoint to change the state of the integration for a client who has authorised your integration in their d6+ SAMS instance. This state indicates whether you are actively servicing the client or not.
Request Headers
Name
Type
Description
HTTP-X-USERNAME*
String
As provided by d6
HTTP-X-PASSWORD*
String
As provided by d6
Request Body
Name
Type
Description
school_id*
Integer
The ID of the school to update
api_type_id*
Integer
The api_type_id returned by the Get Clients endpoint
state*
Boolean
The state you would like to set the integration to
Description: This error occurs when attempting to activate an integration for a school that has not authorized your integration. Schools must first authorize the integration before it can be activated by the integrator.
Status: 401 Unauthorized
{
"success": false,
"message": "Client has not authorised access"
}
Description: When validation failed for one or more fields
Status: 400 Bad Request
{
"success": false,
"message": "Validation Failed",
"validation_errors": {
"api_type_id": "The api_type_id is invalid",
"state": "The State must be a boolean"
}
}