Documentation Index
Fetch the complete documentation index at: https://docs.msgflash.com/llms.txt
Use this file to discover all available pages before exploring further.
Endpoint
GET /api/v1/campaigns/{id}
Parameters path
| Nom | Type | Required | Description |
|---|
id | UUID | yes | Campaign ID |
Success response 200
{
"data": {
"id": "cmp_uuid",
"userId": "user_uuid",
"name": "Promo Black Friday",
"instanceId": "inst_uuid",
"templateId": null,
"type": "image",
"body": "Découvrez notre offre",
"mediaUrl": "https://cdn.example.com/promo.jpg",
"schedule": "2026-04-02T10:00:00.000Z",
"repeat": "noe",
"status": "running",
"recipients": { "type": "all" },
"templateVariables": null,
"stats": {
"planned": 500,
"queued": 120,
"sent": 350,
"delivered": 330,
"read": 210,
"failed": 30,
"cancelled": 0,
"processingStartedAt": "2026-04-02T10:00:01.000Z",
"lastEnqueuedAt": "2026-04-02T10:03:20.000Z",
"completedAt": null,
"cancelledAt": null
},
"createdAt": "2026-04-01T17:00:00.000Z",
"updatedAt": "2026-04-02T10:03:20.000Z"
}
}
Lecture du contenu
- if
templateId is present: the campaign is in template mode
- otherwise if
type is present: the campaign is in direct message mode
body et mediaUrl peuvent alors être affichés dans le détail
Common errors
| HTTP | Code | When |
|---|
404 | NOT_FOUND | Campaign not found |
