Domain management

Update a domain. The target domain is the one linked to the community identified by the community API key provided for authorisation.

Changed on
post/domain

Request

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

Request body

shortNamestring

The domain's short name. Skip this if no update should be made.

fullNamestring

The domain's full name. Skip this if no update should be made.

descriptionstring

The domain's description. Skip this if no update should be made or provide as an empty string to remove the current value.

reportMetadatastring

The domain's additional metadata for XML reports.

Response

Domain updated.

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

    • 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