WhatsApp templates

Update template tracking

Changed on

Change the UTM tags a WhatsApp template adds to its URL buttons, e.g. { "id": "…", "tracking": { "utm": { "campaign": "black_friday" } } }, or { "utm": false } to stop tagging. Works on approved templates with no new review: tags are added when each message is sent. Tracking can only be added to a template that has not been sent for review yet; for an approved template without it, create a new one with tracking.

patch/api/v1/templates/{id}/tracking

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

Template id.

Request body

Response

Success

idstring required

Template id.

namestring required

Template name (unique per WhatsApp account, i.e. across all its numbers).

languagestring required

WhatsApp language code the template was created for, e.g. es_MX.

category'UTILITY' | 'MARKETING' | 'AUTHENTICATION' required
contentType'TEXT' | 'MEDIA' | 'QUICK_REPLY' | 'CALL_TO_ACTION' | 'CARD' required
contentunknown required
variablesobject nullable required

Example values for {{1}}-style placeholders.

phoneNumbersstring[] required

WhatsApp numbers this template can be sent from: every number on the WhatsApp account it was created on.

status'DRAFT' | 'PENDING' | 'APPROVED' | 'REJECTED' required

DRAFT (not yet submitted), PENDING (in WhatsApp review, typically 24-48h), APPROVED, or REJECTED (see rejectionReason).

rejectionReasonstring nullable required
createdAtstring required

ISO 8601 timestamp.

updatedAtstring required

ISO 8601 timestamp.

Changes