Template

Templates are created for sending messages to larger groups of contacts (audience). Using templates multiple times will save time in creating campaigns. Furthermore, each recipient will receive personalized messages even when the templates are applied.

Method: Update

Operation updates the details of the template.

URL /v1/templates/{id}
Method Type PUT
Authorization API Key
Request Content-Type JSON
Response Content-Type JSON

Headers

Name Type Description Status
X-Dexatel-Key string API key Required

Request Body

Name Type Description Status
data object

Details

(see data object below) 		Required
data object
Name Type Description
name string Name (unique identifier) of the template
text string Text of the template with variables

Response Parameters

Name Type Description
data object

Details

(see data object below)
data object
Name Type Description
id string Unique identifier of the template
account_id string Unique identifier of the account
name string Name (unique identifier) of the template
text string Text of the template with variables
channel string Channel for which the template can be used for. Possible values: SMS, VIBER, WHATSAPP.
For example, if the template is created for the SMS or Viber channels, it cannot be used for the WhatsApp campaigns and vice versa
status string Status of the template
create_date string Creation date of the template in UTC, formatted as yyyyMM-dd HH:mm:ss
update_date string Update date of the template in UTC, formatted as yyyyMM-dd HH:mm:ss
links object

Details

(see links object below)
links object
Name Type Description
self string URL of the template
account string URL of the account

Example of request body

PUT: /v1/templates/48e200b7-be98-4360-b5c7-5dfac16b06f9
X-Dexatel-Key: 94d2f2f2884848bca861264ad86d8ace
Content-Type: application/json

                
                        


    


    

        
Example of response body

        

            status - 200                            

                
                        


    


            

            
Error Codes

            

                The following error codes are returned in response to a user’s request which contains
                bad syntax or cannot be fulfilled.
            


            

                

                    
                        

                            Code
                            Description
                        

                    

                    
                                                    

                                1251
                                Template not found
                            

                                                        

                                1253
                                'data' is required
                            

                                                        

                                1254
                                'data.text' is required
                            

                                                        

                                1255
                                'data.text' is invalid
                            

                                                        

                                1256
                                'data.channel' is required
                            

                                                        

                                1257
                                'data.channel' value should be: [SMS, VIBER, WHATSAPP]
                            

                                                        

                                1258
                                'data.name' should be unique
                            

                                                        

                                1259
                                'data.name' is invalid
                            

                                                        

                                1260
                                'data.text' is too long