Update a message template.

put

https://localhost/v4/templates/{uid}

update a message template.

Required scope: write_templates.

Path Params

uid

uuid

required

Template uid

Body Params

Update template params

accessLevel

string

enum

required

The access level of the template. Must be 'location' or 'organization'.

Allowed:

attachmentUrl

string | null

URL of template attachment.

locationUids

array of uuids | null

list of locations or empty list. Required when 'accessLevel' is 'location'.

locationUids

nonDeletable

boolean

Defaults to false

If the template can be deleted.

subject

string

The template subject.

text

string

required

Text of the template message.

title

string

required

Title of the template.

type

string

enum

required

Type of the template. Must be 'custom, 'review_invite', or 'review_invite_backup'

Allowed:

uid

uuid | null

Podium unique identifier for The unique identifier of the template..

Responses

Callback

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response.

defaultError response.