Send Campaign

Send a campaign through an active workspace channel. You can use the template already stored on the campaign or a template specified explicitly in the request.

POST https://api.platica.mx/v1/campaigns/{campaignId}/send

URL parameters

Parameter	Type	Description	Requirement
`campaignId`	string	Unique identifier of the campaign	required

Request examples

Immediate send using the template stored on the campaign

{
  "channelId": "5215512345678",
  "template": {
    "params": ["Juan", "20% de descuento"],
    "sendToProblematic": false,
    "sendToUndeliverable": false
  }
}

Immediate send with a specific template

{
  "channelId": "5215512345678",
  "template": {
    "name": "promo_verano_2026",
    "params": ["Juan", "20% de descuento"],
    "sendToProblematic": false,
    "sendToUndeliverable": false
  }
}

Send with an image and scheduled dates

{
  "channelId": "5215512345678",
  "template": {
    "name": "promo_verano_2026",
    "params": ["Juan"],
    "type": "image",
    "file": "https://example.com/promo.jpg",
    "scheduledDates": [
      "2026-07-01T10:00:00Z",
      "2026-07-08T10:00:00Z"
    ],
    "sendToProblematic": false,
    "sendToUndeliverable": false
  }
}

Send with dynamic buttons

{
  "channelId": "5215512345678",
  "template": {
    "name": "promo_con_enlace",
    "params": ["Juan"],
    "buttons": [
      {
        "index": 0,
        "type": "button",
        "sub_type": "url",
        "text": "Ver oferta",
        "parameters": [
          { "type": "text", "text": "promo2026" }
        ]
      }
    ]
  }
}

Body parameters

Parameter	Type	Description	Requirement
`channelId`	string	SENDER channel the campaign is sent from (`prefixedChannelId`, e.g. `wb-123`)	required
`responderAgentId`	string	Agent that RESPONDS to campaign replies, decoupled from the channel. If omitted, the channel's `defaultAgentId` is used	optional
`template`	object	Template configuration for the send	required

`template` object

Parameter	Type	Description	Requirement
`name`	string	Name of the template to use. If omitted, the template configured on the campaign is used	optional
`params`	string[]	Values for the template's variable parameters, in order	optional
`type`	string	Type of attached media: `"image"`, `"video"`, or `"document"`	optional
`file`	string	`http(s)` URL of the file to attach. Required when the template needs media	optional
`buttons`	array	Dynamic parameters for the template buttons	optional
`scheduledDates`	string[]	Scheduled send dates in ISO 8601 format. Must be future dates	optional
`sendToProblematic`	boolean	Whether to send to contacts with problematic numbers	optional (default `false`)
`sendToUndeliverable`	boolean	Whether to send to contacts with previous failed deliveries	optional (default `false`)

`buttons[]` object

Parameter	Type	Description	Requirement
`index`	number	Index of the button in the template (starts at 0)	required
`type`	string	Component type. If omitted, the API uses `"button"`	optional
`sub_type`	string	Subtype: `"url"`, `"phone_number"`, `"quick_reply"`, or `"otp"`	optional
`text`	string	Button text. The API can infer it from the template	optional
`placeholder`	string	Placeholder or base value defined in the template for dynamic buttons	optional
`parameters`	array	Dynamic parameters of the button	required

`buttons[].parameters[]` object

Parameter	Type	Description	Requirement
`type`	string	Button parameter type	required
`text`	string	Text value of the parameter	required
`url`	string	URL associated with the parameter when applicable	optional
`selectedFields`	string[]	Selected fields to map dynamic content	optional

Response `200 OK`

{
  "status": "success",
  "message": "Campaign sent successfully",
  "data": {
    "status": "queued"
  }
}

data contains the response from the upstream sending service, so its structure can vary across workspaces or integrations.

Notes

channelId is the SENDER channel. The responding agent is controlled with responderAgentId (decoupled from the channel): you can send from one number and have a specific agent handle replies without changing the agent connected to that channel. If you omit responderAgentId, the channel's defaultAgentId responds.
If template.name is omitted, the campaign's saved template is used. If the campaign has no configured template, the send fails with 400.
The number of items in params must match exactly the number of variables expected by the template.
If you send buttons, the number of buttons and their indexes must exist in the validated template.
When the template needs media, file must be a valid http or https URL.
All scheduledDates must be in the future at request time.

Previous Delete Campaign Next Get Audience