Skip to content

/merchants/{merchantCode}/templates/{templateCode} (POST)

POST
/merchants/{merchantCode}/templates/{templateCode}

Updates a template

merchantCode
required
string
templateCode
required
string
Media typeapplication/json
object
name
string
>= 1 characters <= 255 characters
Example
Our great template
triggerType
string
Allowed values: event other
eventType

Only needed if type is event. With the option “custom” you can listen to custom events from external systems. If custom is set the property “customEventType” must be set

string
Allowed values: fulfillmentOrderUpdated fulfillmentOrderStatusUpdated orderNotPickedUp salesOrderAdded salesOrderFulfillmentAdded schedulePickupReminderTimeReached cartReminderTimeReached inactiveDeviceTimeReached returnOrderAdded returnOrderStatusUpdated productInventoryRestocked custom
description
string
Example
description of the entity
messages
object
key
additional properties
Array
object
title
required
string
<= 255 characters
Example
TheTitle
body
required
string
Example
BodyBodyBody
image
string | null
<= 255 characters
Example
http://url
imageType
string
Allowed values: custom externalUrl product
Example
custom
shared
number
default: 1
Example
1
status
string
default: active
Allowed values: active inactive

Successfully updated the template

Media typeapplication/json