Templates

SMS (DLT), email and WhatsApp templates with variables, previews, the seeded library and DLT import.

GET/v1/templates

Message templates

Access: API key with templates:read, or a member session. Permission templates.view.

Parameters

channelquery: TemplateChannel
statusquery: TemplateStatus
use_casequery: string
languagequery: string
qquery: string

Response · 200

datarequired: array of MessageTemplate
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/templates' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "channel": "sms",
      "name": "string",
      "display_name": "string",
      "language": "string",
      "category": "string",
      "use_case": "string",
      "header": null,
      "body": "string",
      "footer": "string",
      "buttons": null,
      "variables": [
        {
          "index": 1,
          "key": "string",
          "path": "string",
          "label": "string",
          "sample": "string",
          "fallback": "string",
          "max_length": 1
        }
      ],
      "provider_template_id": "string",
      "dlt_template_id": "string",
      "dlt_header": "string",
      "channel_account_id": "cmusrceel0000q7kaafxqi1om",
      "status": "draft",
      "rejection_reason": "string",
      "quality": "string",
      "last_synced_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "placeholders": 0,
      "sms": {
        "encoding": "gsm",
        "parts": 0
      }
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/templates

Create a template

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.edit.

Request body

channelrequired: TemplateChannel
namerequired: string
language: string
display_name: string or null
categoryrequired: string
use_case: string or null
header: any
email: { type: "email", subject, text? } · WhatsApp: { type, text? }
bodyrequired: string
footer: string or null
buttons: any
variables: array of TemplateVariableInput
dlt_template_id: string or null
dlt_header: string or null
provider_template_id: string or null
channel_account_id: Id or null
Opaque record id.

Response · 201

datarequired: MessageTemplate
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/templates' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"channel":"sms","name":"string","language":"en","display_name":"string","category":"string","use_case":"string","header":null,"body":"string","footer":"string","buttons":null,"variables":[{"index":1,"key":"string","path":"string","label":"string","sample":"string","fallback":"string","max_length":1}],"dlt_template_id":"string","dlt_header":"string","provider_template_id":"string","channel_account_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "sms",
    "name": "string",
    "display_name": "string",
    "language": "string",
    "category": "string",
    "use_case": "string",
    "header": null,
    "body": "string",
    "footer": "string",
    "buttons": null,
    "variables": [
      {
        "index": 1,
        "key": "string",
        "path": "string",
        "label": "string",
        "sample": "string",
        "fallback": "string",
        "max_length": 1
      }
    ],
    "provider_template_id": "string",
    "dlt_template_id": "string",
    "dlt_header": "string",
    "channel_account_id": "cmusrceel0000q7kaafxqi1om",
    "status": "draft",
    "rejection_reason": "string",
    "quality": "string",
    "last_synced_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "placeholders": 0,
    "sms": {
      "encoding": "gsm",
      "parts": 0
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/templates/dlt-import

Import DLT templates (CSV)

The template export of the operator’s DLT portal, as text. Rows with problems are reported and skipped.

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.edit.

Request body

csvrequired: string

Response · 200

datarequired: object
data.createdrequired: integer
data.updatedrequired: integer
data.unchangedrequired: integer
data.skippedrequired: integer
data.headers_addedrequired: array of string
data.missing_columnsrequired: array of string
data.rowsrequired: array of object
data.rows[].rowrequired: integer
data.rows[].template_idrequired: string
data.rows[].namerequired: string
data.rows[].outcomerequired: "created" | "updated" | "unchanged" | "skipped"
data.rows[].errorsrequired: array of string
data.rows[].warningsrequired: array of string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/templates/dlt-import' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"csv":"string"}'

Response example

{
  "data": {
    "created": 0,
    "updated": 0,
    "unchanged": 0,
    "skipped": 0,
    "headers_added": [
      "string"
    ],
    "missing_columns": [
      "string"
    ],
    "rows": [
      {
        "row": 0,
        "template_id": "string",
        "name": "string",
        "outcome": "created",
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/templates/library

Add the template library

Adds the seeded Indian real-estate templates the company does not have yet; never overwrites.

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.edit.

Request body (optional)

channels: array of TemplateChannel

Response · 200

datarequired: object
data.createdrequired: integer
data.skippedrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/templates/library' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"channels":["sms"]}'

Response example

{
  "data": {
    "created": 0,
    "skipped": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/templates/preview

Preview an unsaved template

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.view.

Request body

record: object
Fill the variables from this record; sample data when absent.
record.contact_id: Id
Opaque record id.
record.lead_id: Id
Opaque record id.
record.property_id: Id
Opaque record id.
record.project_id: Id
Opaque record id.
record.visit_id: Id
Opaque record id.
vars: map of string
draftrequired: object
draft.channelrequired: TemplateChannel
draft.language: string
draft.display_name: string or null
draft.categoryrequired: string
draft.use_case: string or null
draft.header: any
email: { type: "email", subject, text? } · WhatsApp: { type, text? }
draft.bodyrequired: string
draft.footer: string or null
draft.buttons: any
draft.variables: array of TemplateVariableInput
draft.dlt_template_id: string or null
draft.dlt_header: string or null
draft.provider_template_id: string or null
draft.channel_account_id: Id or null
Opaque record id.

Response · 200

datarequired: TemplatePreview
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/templates/preview' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"record":{"contact_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","property_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","visit_id":"cmusrceel0000q7kaafxqi1om"},"vars":{},"draft":{"channel":"sms","language":"en","display_name":"string","category":"string","use_case":"string","header":null,"body":"string","footer":"string","buttons":null,"variables":[{"index":1,"key":"string","path":"string","label":"string","sample":"string","fallback":"string","max_length":1}],"dlt_template_id":"string","dlt_header":"string","provider_template_id":"string","channel_account_id":"cmusrceel0000q7kaafxqi1om"}}'

Response example

{
  "data": {
    "channel": "sms",
    "source": "sample",
    "text": "string",
    "subject": "string",
    "html": "string",
    "params": [
      "string"
    ],
    "issues": [
      {
        "code": "string",
        "detail": "string",
        "blocking": true
      }
    ],
    "sms": {
      "encoding": "gsm",
      "parts": 0,
      "units": 0
    },
    "rera": {
      "numbers": [
        "string"
      ],
      "authority_url": "string"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/templates/variables

Variables a template can use

Access: API key with templates:read, or a member session. Permission templates.view.

Response · 200

datarequired: array of object
data[].keyrequired: string
data[].labelrequired: string
data[].samplerequired: string
data[].grouprequired: string
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/templates/variables' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "key": "string",
      "label": "string",
      "sample": "string",
      "group": "string"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/templates/{id}

A template

Access: API key with templates:read, or a member session. Permission templates.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: MessageTemplate
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/templates/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "sms",
    "name": "string",
    "display_name": "string",
    "language": "string",
    "category": "string",
    "use_case": "string",
    "header": null,
    "body": "string",
    "footer": "string",
    "buttons": null,
    "variables": [
      {
        "index": 1,
        "key": "string",
        "path": "string",
        "label": "string",
        "sample": "string",
        "fallback": "string",
        "max_length": 1
      }
    ],
    "provider_template_id": "string",
    "dlt_template_id": "string",
    "dlt_header": "string",
    "channel_account_id": "cmusrceel0000q7kaafxqi1om",
    "status": "draft",
    "rejection_reason": "string",
    "quality": "string",
    "last_synced_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "placeholders": 0,
    "sms": {
      "encoding": "gsm",
      "parts": 0
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/templates/{id}

Update a template

DLT-registered SMS text is immutable (re-import it); editing an approved WhatsApp template sends it back to draft.

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

display_name: string or null
category: string
use_case: string or null
header: any
email: { type: "email", subject, text? } · WhatsApp: { type, text? }
body: string
footer: string or null
buttons: any
variables: array of TemplateVariableInput
dlt_template_id: string or null
dlt_header: string or null
provider_template_id: string or null
channel_account_id: Id or null
Opaque record id.
status: "approved" | "paused" | "disabled"

Response · 200

datarequired: MessageTemplate
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/templates/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"display_name":"string","category":"string","use_case":"string","header":null,"body":"string","footer":"string","buttons":null,"variables":[{"index":1,"key":"string","path":"string","label":"string","sample":"string","fallback":"string","max_length":1}],"dlt_template_id":"string","dlt_header":"string","provider_template_id":"string","channel_account_id":"cmusrceel0000q7kaafxqi1om","status":"approved"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "sms",
    "name": "string",
    "display_name": "string",
    "language": "string",
    "category": "string",
    "use_case": "string",
    "header": null,
    "body": "string",
    "footer": "string",
    "buttons": null,
    "variables": [
      {
        "index": 1,
        "key": "string",
        "path": "string",
        "label": "string",
        "sample": "string",
        "fallback": "string",
        "max_length": 1
      }
    ],
    "provider_template_id": "string",
    "dlt_template_id": "string",
    "dlt_header": "string",
    "channel_account_id": "cmusrceel0000q7kaafxqi1om",
    "status": "draft",
    "rejection_reason": "string",
    "quality": "string",
    "last_synced_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "placeholders": 0,
    "sms": {
      "encoding": "gsm",
      "parts": 0
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/templates/{id}

Delete a template

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.delete.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/templates/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "deleted": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/templates/{id}/preview

Preview a template

Access: API key with templates:read, or a member session. Permission templates.view.

Parameters

idpathrequired: Id
Opaque record id.

Request body

record: object
Fill the variables from this record; sample data when absent.
record.contact_id: Id
Opaque record id.
record.lead_id: Id
Opaque record id.
record.property_id: Id
Opaque record id.
record.project_id: Id
Opaque record id.
record.visit_id: Id
Opaque record id.
vars: map of string

Response · 200

datarequired: TemplatePreview
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/templates/{id}/preview' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"record":{"contact_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","property_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","visit_id":"cmusrceel0000q7kaafxqi1om"},"vars":{}}'

Response example

{
  "data": {
    "channel": "sms",
    "source": "sample",
    "text": "string",
    "subject": "string",
    "html": "string",
    "params": [
      "string"
    ],
    "issues": [
      {
        "code": "string",
        "detail": "string",
        "blocking": true
      }
    ],
    "sms": {
      "encoding": "gsm",
      "parts": 0,
      "units": 0
    },
    "rera": {
      "numbers": [
        "string"
      ],
      "authority_url": "string"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "channel": "sms", "name": "string", "display_name": "string", "language": "string", "category": "string", "use_case": "string", "header": null, "body": "string", "footer": "string", "buttons": null, "variables": [ { "index": 1, "key": "string", "path": "string", "label": "string", "sample": "string", "fallback": "string", "max_length": 1 } ], "provider_template_id": "string", "dlt_template_id": "string", "dlt_header": "string", "channel_account_id": "cmusrceel0000q7kaafxqi1om", "status": "draft", "rejection_reason": "string", "quality": "string", "last_synced_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "placeholders": 0, "sms": { "encoding": "gsm", "parts": 0 } } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/templates' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"channel":"sms","name":"string","language":"en","display_name":"string","category":"string","use_case":"string","header":null,"body":"string","footer":"string","buttons":null,"variables":[{"index":1,"key":"string","path":"string","label":"string","sample":"string","fallback":"string","max_length":1}],"dlt_template_id":"string","dlt_header":"string","provider_template_id":"string","channel_account_id":"cmusrceel0000q7kaafxqi1om"}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "channel": "sms", "name": "string", "display_name": "string", "language": "string", "category": "string", "use_case": "string", "header": null, "body": "string", "footer": "string", "buttons": null, "variables": [ { "index": 1, "key": "string", "path": "string", "label": "string", "sample": "string", "fallback": "string", "max_length": 1 } ], "provider_template_id": "string", "dlt_template_id": "string", "dlt_header": "string", "channel_account_id": "cmusrceel0000q7kaafxqi1om", "status": "draft", "rejection_reason": "string", "quality": "string", "last_synced_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "placeholders": 0, "sms": { "encoding": "gsm", "parts": 0 } }, "meta": {} }

{ "data": { "created": 0, "updated": 0, "unchanged": 0, "skipped": 0, "headers_added": [ "string" ], "missing_columns": [ "string" ], "rows": [ { "row": 0, "template_id": "string", "name": "string", "outcome": "created", "errors": [ "string" ], "warnings": [ "string" ] } ] }, "meta": {} }

POST/v1/templates/library

Add the template library

Adds the seeded Indian real-estate templates the company does not have yet; never overwrites.

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.edit.

Request body (optional)

channels: array of TemplateChannel

Response · 200

datarequired: object
data.createdrequired: integer
data.skippedrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/templates/library' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"channels":["sms"]}'

Response example

{
  "data": {
    "created": 0,
    "skipped": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

curl -X POST 'https://api.propzolo.com/v1/templates/preview' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"record":{"contact_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","property_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","visit_id":"cmusrceel0000q7kaafxqi1om"},"vars":{},"draft":{"channel":"sms","language":"en","display_name":"string","category":"string","use_case":"string","header":null,"body":"string","footer":"string","buttons":null,"variables":[{"index":1,"key":"string","path":"string","label":"string","sample":"string","fallback":"string","max_length":1}],"dlt_template_id":"string","dlt_header":"string","provider_template_id":"string","channel_account_id":"cmusrceel0000q7kaafxqi1om"}}'

{ "data": { "channel": "sms", "source": "sample", "text": "string", "subject": "string", "html": "string", "params": [ "string" ], "issues": [ { "code": "string", "detail": "string", "blocking": true } ], "sms": { "encoding": "gsm", "parts": 0, "units": 0 }, "rera": { "numbers": [ "string" ], "authority_url": "string" } }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/templates/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"display_name":"string","category":"string","use_case":"string","header":null,"body":"string","footer":"string","buttons":null,"variables":[{"index":1,"key":"string","path":"string","label":"string","sample":"string","fallback":"string","max_length":1}],"dlt_template_id":"string","dlt_header":"string","provider_template_id":"string","channel_account_id":"cmusrceel0000q7kaafxqi1om","status":"approved"}'

curl -X POST 'https://api.propzolo.com/v1/templates/{id}/preview' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"record":{"contact_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","property_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","visit_id":"cmusrceel0000q7kaafxqi1om"},"vars":{}}'