Kumulos provides a RESTful API that allows managing the creation of In-App templates, for later use by the public messaging API.

Note that all references to "content" in In-App templates refer to the JSON template definition as specified separately in the schema definition.

Headers¶

Please ensure that you set the following headers in your request:

Content-Type: application/json
Accept: application/json

Authentication¶

The API authenticates via HTTP Basic Auth using your app's API Key as the username and your Server Key as the password (in the Authorization header). Both of these are available from the App Dashboard in your Agency Console.

Template UIDs will be used in RESTful uri paths, these should either use url safe characters or should be encoded prior to send.

Create¶

POST https://messages.kumulos.com/v1/templates/in-app¶

{
    "name": string, max:255
    "uid": string, max:255, allowed alphanumeric and dashes, used to identify the template during sends
    "content": [json schema]
}

Responses¶

401 Unauthorized¶

Your request was rejected because the authorization header was not provided or poorly formed. Check your API Key, Server Key and that you have followed the HTTP Basic authentication strategy.

422 Unprocessable Entity¶

No user matching the specified identifer was found.

201 Created¶

Your request was processed. The response body will reflect the templated created as a result of the request.

{
    "name": "mytemplate",
    "uid": "mytemplate",
    "content": [json schema],
    "dynamicContentTags": [],
    "updatedAt": "2021-08-31T13:55:58+0000",
    "createdAt": "2021-08-31T13:55:58+0000",
    "appId": 1,
}

Update¶

PUT https://messages.kumulos.com/v1/templates/in-app/{uid}¶

{
    "name": string, max:255
    "uid": string, max:255, suggested alphanumeric and dashes, used to identify the template during sends
    "content": [json schema]
}

Responses¶

401 Unauthorized¶

Your request was rejected because the authorization header was not provided or poorly formed. Check your API Key, Server Key and that you have followed the HTTP Basic authentication strategy.

404 Not Found¶

The template specified by UID in the url could not be found.

422 Unprocessable Entity¶

No user matching the specified identifer was found.

200 OK¶

Your request was processed. The response body will reflect the templated updated as a result of the request.

{
    "name": "mytemplate",
    "uid": "mytemplate",
    "content": [json schema],
    "dynamicContentTags": [],
    "updatedAt": "2021-08-31T13:55:58+0000",
    "createdAt": "2021-08-31T13:55:58+0000",
    "appId": 1,
}

Delete¶

DELETE https://messages.kumulos.com/v1/templates/in-app/{uid}¶

Responses¶

401 Unauthorized¶

Your request was rejected because the authorization header was not provided or poorly formed. Check your API Key, Server Key and that you have followed the HTTP Basic authentication strategy.

404 Not Found¶

The template specified by UID in the url could not be found.

204 Not Content¶

Your request was processed. The template has been deleted.