BusinessDomains
Update BusinessDomain
Update an existing BusinessDomain record.
PUT
Update BusinessDomain
Updates an existing BusinessDomain record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the BusinessDomain-Edit role.Request Body
Required Fields
The Id of the BusinessDomain record to update.
ID of the business linked to this record.
Display name for this domain mapping.
The custom domain or subdomain hostname — despite the name, this is just the bare domain (e.g. coworking.com or london.coworking.com), without https:// or any path.
Optional Fields
Whether this domain mapping is active.
Must always be set to true.
Date from which this domain mapping becomes active.
Date after which this domain mapping is no longer active.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the businessdomain was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update BusinessDomain