Skip to main content
GET
Download audience format
Use this endpoint to download an Excel template for uploading audience data to a campaign.

Endpoint

GET /audience-format Authentication: Required (workspace auth)

Query Parameters

Response

Returns a downloadable Excel file (.xlsx).
  • Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • Filename: audience_format_<timestamp>.xlsx

Template Columns

The Excel file always includes mobile_no as the first column. Additional columns are dynamically generated based on the agent’s configured metadata input fields.

Notes

  • The campaign must have an agent assigned. If no agent is linked, the request returns an error.
  • Fill the template and upload it when creating or updating a campaign via the audience field.

Error Cases

Example cURL

Headers

token
string
required

API token for authentication

Query Parameters

campaign_id
integer
required

Campaign identifier

Response

Excel file download

The response is of type file.