PUT Whitelisting Domain Status
Overview
The following table contains information about the PUT method for updating a whitelisting domain's status.
| PUT Whitelisting Domain | |
|---|---|
| Method | PUT |
| URL or Endpoint | /api/projects/projectId/whitelisting-domains/id/status |
| Headers | Authorization |
| Parameters | id, projectId, active |
| Body | Not Applicable |
URL Parameters
| URL Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
| Parameter Name | Mandatory | Type | Description |
| projectId | Yes | string | Unique ID of the project. |
| active | Yes | bool | Status to which it shpuld be updated. |
Request Body
This request does not contain a request body.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": true,
"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 | bool | Returns the response |
| 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