CustomDocDomains

Updates a custom domain

Updates properties of a document's custom domain.

patch/docs/{docId}/domains/{customDocDomain}

Request

  • Base URL: https://docs.superhuman.com/apis/v1
  • URL: https://docs.superhuman.com/apis/v1/docs/{docId}/domains/{customDocDomain}
  • Auth: HTTP bearer

Path parameters

docIdstring required

ID of the doc.

customDocDomainstring required

A custom domain for a published doc.

Request body

UpdateCustomDocDomainRequest required

Payload for updating the properties of a custom published doc domain.

Response

The custom domain object with the updates applied.

UpdateCustomDocDomainResponse required

The result of updating a custom domain for a published doc.

Changes

No recorded changes to this operation across all 1 revision of this API.