Search
K
Yuki Platform API Prod

Update Domain

This endpoint allows the modification of an existing domain’s details. Ensure you have the necessary permissions before attempting to update a domain. You should have yukiapi:domain:domains:write and yukiapi:domain:domains:update scopes to access this endpoint.

put
https://apirest.yukiworks.com/api/v1/portals/{portal-id}/domains/byName

Query Parameters

domain-namestringrequired

The domain name

Path Parameters

portal-idstringrequired

The portal id

Example:3afb7b54-6144-4561-9a29-1148006f2375

Headers

Authorizationstringrequired

Bearer token for authentication

Content-Typestringrequired

Content type, must be application/json

Allowed values:application/json

Body

application/json

UpdateDomain

Schema for updating an existing domain.

* Additional properties are NOT allowed.
backOfficeobjectrequired

Back office configuration settings.

Show Child Parameters

Response

Domain updated successfully.

  
curl --request PUT \
  --url 'https://apirest.yukiworks.com/api/v1/portals/3afb7b54-6144-4561-9a29-1148006f2375/domains/byName?domain-name=' \
  --header 'Accept: application/problem+json' \
  --header 'Content-Type: application/json' \
  --data '{
  "backOffice": {
    "access": "AllEmployees"
  }
}'
Domain updated successfully.