Skip to main content
POST
/
messaging
/
templates
Create message template
curl --request POST \
  --url https://api.partoo.co/v2/messaging/templates \
  --header 'Content-Type: application/json' \
  --header 'x-APIKey: <api-key>' \
  --data '{
  "title": "Quote request",
  "icon": "📝",
  "content": "{\"text\": \"Hello, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}"
}'
{
  "id": "642bca3d2830e15c6806cc33",
  "title": "Quote request",
  "content": "{\"text\": \"Hello {{client_full_name}}, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}",
  "icon": "📝",
  "org_id": 123,
  "created_at": "2023-01-31T16:22:17.327878+00:00",
  "updated_at": "2023-02-15T10:00:00.000000+00:00",
  "usage_count": 50
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Body

application/json
​
title
string
required

The title of the template

Example:

"Quote request"

​
content
string
required

The template content as a stringified JSON object with "_version": "0.1" inside

Example:

"{\"text\": \"Hello, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}"

​
icon
string

The icon linked to the template

Example:

"📝"

Response

The message template created

​
id
string
Example:

"642bca3d2830e15c6806cc33"

​
title
string

The title of the message template.

Example:

"Quote request"

​
content
enum<string>

The content of the message template should be a stringified JSON object. This includes both the message content ("text") and the pair "_version": "0.1".

The "text" can contain placeholders (values from the enum above within double curly braces {{}}) that will be replaced with the actual values when the message is sent.

Available options:
client_full_name,
client_first_name,
business_name,
my_first_name,
rb_link,
address,
website_url,
phone_number
Example:

"{\"text\": \"Hello {{client_full_name}}, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}"

​
icon
string | null

The icon associated with the message template.

Example:

"📝"

​
org_id
integer

The organization ID that the message template belongs to.

Example:

123

​
created_at
string<date-time>

The date and time when the message template was created, in ISO 8601 format.

Example:

"2023-01-31T16:22:17.327878+00:00"

​
updated_at
string<date-time> | null

The date and time when the message template was last updated, in ISO 8601 format.

Example:

"2023-02-15T10:00:00.000000+00:00"

​
usage_count
integer

The number of times the message template has been used.

Example:

50