FOfonoa
Onboarding

Update document template details

Update document template metadata and/or HTML content. Only the fields listed here are available to update.

patch/onboarding/v2/templates/{id}

Request

  • The document declares no server URL.
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

idstring required

The identifier of the document template

Request body

contentstring

Raw HTML document template content (maximum 65536 bytes). Omitted or empty values leave existing content unchanged.

Validations:

  • Length ({{.actual}}) must be between {{.min}} and {{.max}} bytes long.
namestring

Display name for the document template

statusstring

Document template status

Validations:

  • Values allowed are (letter case matters): active, inactive

Response

Ok - document template was updated successfully.

messagestring
statusstring

The status of the request.

Example response

{
  "errors": [
    {
      "type": "validation"
    }
  ]
}

Changes

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