Skip to main content
PUT
Update Domain Mapping

Authorizations

Authorization
string
header
required

Bearer token for authentication

Path Parameters

domain_mapping_id
string
required

The UUID of the domain mapping to edit

Body

application/json

DomainMappingEditRequest

Schema for editing a domain mapping

conditions
ConditionCreate · object[] | null

List of conditions to create and attach to the created domain mapping.

enabled
boolean | null
default:true

Whether the domain mapping is enabled. Defaults to true.

Example:

true

sync_triggers
SyncTriggerUpdate · object[] | null

List of sync triggers to upsert and attach to the created domain mapping. NOTE: Currently only one sync trigger can be created while creating a domain mapping. If multiple sync triggers are specified, only the first will be used. This restriction will be lifted in the future.

Response

Domain Mapping Response

Response schema for a single domain mapping.

data
DomainMapping · object

An object representing a domain mapping.