Sign in

Create or edit a template message

Creates a template message in one of the creator's folders, or edits an existing one. Provide a folderUuid from GET /chats/templates/folders. Omit messageUuid to create the template (201); provide it to edit that template in place (200). A template must have text or at least one media attachment. An edit replaces the fields you send, so send the full template body rather than only the fields you are changing.

post/chats/templates

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Request body

messageUuidstring uuid

UUID of an existing template to edit. Omit to create a new template; provide it to edit that template in place.

folderUuidstring uuid required

UUID of the folder to hold the template (see GET /chats/templates/folders)

textstring

Message text content

mediaUuidsstring[]

Media UUIDs to attach to the template, in display order

mediaPreviewUuidstring uuid

Media UUID to use as the paywall preview

namestring

Optional template name

Response

Template message updated

uuidstring uuid required

Template message UUID

namestring nullable required

Template name as given on create, or null when the template is unnamed

textstring nullable required

Message text content

pricenumber nullable required

Message price in cents (null for free messages)

mediaUuidsstring[] required

Array of media UUIDs attached to the message

mediaPreviewUuidstring uuid nullable required

Media UUID used as the paywall preview (null when the template has none)

folderUuidstring uuid nullable required

UUID of the folder containing this template

folderNamestring nullable required

Name of the folder containing this template

Changes

Changed in 1 of the 2 revisions of this API.3

  • dce5621fe5893See the full diff
    • ○

      api operation id createTemplateMessage removed and replaced with upsertTemplateMessage

      api-operation-id-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the success response with the status

      response-success-status-added