POST to Activate or Deactivate Role

Overview

---

The following table contains important information about the POST method in regards to activating or deactivating a role.

POST to Activate or Deactivate Role
Method	POST
URL or Endpoint	/api/roles/activate
Headers	Authorization
Parameters	projectId, id
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

The description of the parameter is as follows:

id Parameter
Parameter Name	id
Mandatory	Yes
Type	integer($int32)
Description	Unique Id of the role.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [
    "Role deactivated successfully!"
  ],
  "result": false,
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed