Configuration

Update a domain parameter.

Changed on
post/configure/domain

Request

  • Base URL: ${apiUrl} (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ${apiUrl}/configure/domain
  • Auth: API key in header ITB_API_KEY

Request body

keystring required

The unique key used to identify the parameter.

valuestring

The new value to apply for the parameter. Skip this if no update should be made.

descriptionstring

The parameter's description. Skip this if no update should be made or set with an empty string to delete the current value.

inTestsboolean

Whether the parameter should be exposed to test sessions. Skip this if no update should be made.

domainstring

The API key identifying the domain of the parameter. This is required if the community API key used for authentication refers to a community that is not linked to a specific domain.

Response

Domain parameter updated.

Changes

  • 26fb91f21fa6Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 433b3c0ae6d4Revision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status