Updating templates
You can update your template by using the URL below. Currently the only parameter that can be updated is active
(true/false). The message templates contained in each template can be altered by following these instructions.
PUT https://confirmation-api.paycertify.com/api/confirmation_templates/{confirmation_template_id}
Parameter | Type | Presence | Description | Example |
active |
boolean |
required | true, false |
Field | Type | Description | Example | |
---|---|---|---|---|
id |
uuid |
The template ID | 63693de5-8a19-4233-b382-c75f0c6b31aa | |
process_name |
string |
Type of process to confirm | email_ecommerce , email_moto , phone_ecommerce , phone_moto , email_moto_secure , phone_moto_secure |
|
active |
boolean |
Status of this template | true | |
message_templates.*.message_key |
string |
A mnemonic that identifies the message | email_body |
|
message_templates.*.content |
string |
The message’s content. Words between curly-brackets `` are variables that will be replaced by their values in the actual messages. | - | |
message_templates.*.content_type |
string |
Message content type. Possible values are text and html |
text |
|
message_templates.*.created_at |
datetime |
- | Time that event was created, on ISO 8601 UTC | 2018-07-04T19:52:22.787Z |
message_templates.*.updated_at |
datetime |
- | Last time this event was updated, on ISO 8601 UTC | 2018-07-04T19:52:22.789Z |
curl --request PUT \
--url https://confirmation-api.paycertify.com/api/confirmation_templates/63693de5-8a19-4233-b382-c75f0c6b31aa \
--header 'Authorization: Bearer D28A17DFD326A2E255DC4C69C17C2451446A7EC8' \
--header 'Cache-Control: no-cache' \
--form active=false
Responds with:
{
"id": "63693de5-8a19-4233-b382-c75f0c6b31aa",
"process_name": "email_moto",
"active": false,
"message_templates": [
{
"message_key": "email_body",
"content": "Hello, . This is a confirmation message. Please confirm it by clicking <a href=''>this link</a>",
"content_type": "html",
"created_at": "2018-07-04T19:52:22.787Z",
"updated_at": "2018-07-04T19:52:22.787Z"
},
{
"message_key": "agreement",
"content": "<p>By confirming this order you agree with the disclaimer mentioned above.</p><a href=''>click this link</a>.",
"content_type": "html",
"created_at": "2018-07-04T19:52:22.789Z",
"updated_at": "2018-07-04T19:52:22.789Z"
},
{
"message_key": "thank_you",
"content": "Thank you.",
"content_type": "html",
"created_at": "2018-07-04T19:52:22.790Z",
"updated_at": "2018-07-04T19:52:22.790Z"
}
]
}