Update environment domain

updateDomain(input: UpdateDomainInput!): UpdateDomainPayload!

Requires project.domains.write.

Arguments

ArgumentTypeRequired
inputUpdateDomainInput!Yes

Input fields

input

UpdateDomainInput

FieldTypeRequired
environmentIdID!Yes
domainIdID!Yes
domainString!Yes

Response

Returns UpdateDomainPayload!. Open the type for its fields and nested types.

FieldType
domainDomain
errorString

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation UpdateDomain($input: UpdateDomainInput!) {
  updateDomain(input: $input) {
    error
  }
}
json
{
  "input": {
    "environmentId": "00000000-0000-4000-8000-000000000001",
    "domainId": "00000000-0000-4000-8000-000000000001",
    "domain": "example"
  }
}