PUT Whitelisting Domain

Overview

---

The following table contains information about the PUT method for updating a whitelisting domain.

PUT Whitelisting Domain
Method	PUT
URL or Endpoint	/api/projects/projectId/whitelisting-domains
Headers	Authorization
Parameters	projectId
Body	Check the request body below.

The description of the URL parameter is as follows:

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

Request Body

{
  "id": 0,
  "domain": "string"
}

Information about the fields that appear on the request body are displayed in the table below.

Parameter Name	Mandatory	Type	Description
id	Yes	integer	Unique ID of the whitelisting domain.
domain	Yes	string	The domain to be whitelisted.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": 0,
    "domain": "string"
  },
  "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, it will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns response messages from the back-end.
result	object	Returns the response object.
id	integer	Unique ID of the whitelisting domain.
domain	string	The whitelisted domain.
resultInfo	string	Returns additional information about the result.
statusCode	integer	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