Export campaigns

Exports the filtered campaign list as a CSV file (same filters as List campaigns: status, channel/provider type, date range). Returns a downloadable file (application/octet-stream) rather than JSON.

Authentication: Authorization: Bearer <JWT> (obtain via Partner login, refresh via Refresh token).

Body fields

pageNumber (integer, default 1) - 1-based page index. For mode = All/Filtered the whole result set is exported, so pagination is ignored.

pageSize (integer, 1-1000, default 20) - records per page; ignored for full exports.

search (string, optional) - free-text filter matched against the campaign name (case-insensitive, partial).

status (string, optional) - filter by campaign status; omit to include all statuses.

providerType (string, optional) - filter by channel/provider type (e.g. Sms, Viber, Whatsapp); omit for all.

channelsUsed (string[], optional) - restrict to campaigns that use these channels; combined per channelFilterMode.

channelFilterMode (string, optional) - "ALL" = campaign must use exactly these channels (all present, none extra); any other value or omitted = match campaigns using any of them.

sortBy (string, optional) - one of name, status, scheduleDate, modifiedAt, createdAt; unknown/omitted defaults to createdAt.

sortDescending (boolean, default true) - true = descending, false = ascending.

mode (enum All | Selected | Filtered, default Filtered) - All = every campaign (filters ignored); Filtered = all campaigns matching the filters above, without pagination; Selected = only the campaigns listed in ids.

ids (GUID[], optional) - campaign IDs to export. Required when mode = Selected; ignored otherwise.

Example request

curl --location 'https://api.veloconnect.me/api/v2/campaigns/export' \ --header 'Content-Type: application/json' \ --data '{ "pageNumber": 0, "pageSize": 0, "search": "string", "status": "string", "providerType": "string", "channelsUsed": [ "string" ], "channelFilterMode": "string", "sortBy": "string", "sortDescending": true, "mode": "All", "ids": [ "string" ] }'

Export campaigns

Request

Responses