Update campaign

Replaces the editable fields of a not-yet-sent (draft/scheduled) campaign identified by {id}. The body mirrors Create campaign (minus Pipedrive activities).

Authentication: Authorization: Bearer <JWT>.

Path parameters

id (GUID, required) - the campaign to update.

Body fields

name (string, required) - campaign name.

scheduleDate (date-time, optional) - when to send; omit/null = send immediately.

timezone (number, optional) - UTC offset in hours applied to scheduleDate.

timezoneId (string, optional) - IANA timezone id (e.g. Asia/Yerevan) for scheduleDate.

segmentIds (long[], optional) - segments whose contacts are recipients.

quickAddPhoneNumbers (string[], optional) - ad-hoc phone recipients in E.164 (e.g. +37477123456).

quickAddEmails (string[], optional) - ad-hoc email recipients.

saveQuickAddAsContacts (boolean, default false) - persist quick-add recipients as contacts.

isOptin (boolean, default false) - Viber opt-in invitation campaign (sends an opt-in request to not-yet-opted-in contacts); requires a Viber channel.

sendToAll (boolean, optional) - Viber promotional send to all regardless of opt-in; false/null = opted-in only. Ignored for opt-in/OTP.

maxContactsCount (integer >= 1, optional) - cap recipients to the first N; null/0 = no limit.

optinConsentAcknowledged (boolean, default false) - set true when confirming the "Contact Not Opted In" prompt; stored for audit.

channels (array, required) - one entry per channel, tried in priorityOrder. See Create campaign for the full per-channel field list (providerType, priorityOrder, communicationType, message/templateId, senderId/openSenderTitle, price/cost, Telegram options).

Example request

curl --location --request PUT 'https://api.veloconnect.me/api/v2/campaigns/' \ --header 'Content-Type: application/json' \ --data '{ "name": "string", "scheduleDate": "2025-01-01T00:00:00Z", "timezone": 0, "timezoneId": "string", "segmentIds": [ 0 ], "quickAddPhoneNumbers": [ "string" ], "quickAddEmails": [ "string" ], "saveQuickAddAsContacts": true, "channels": [ { "providerType": "Whatsapp", "priorityOrder": 0, "communicationType": "Trasnsactional", "message": "string", "templateId": 0, "senderId": 0, "openSenderTitle": "string", "customerTrunkId": 0, "price": 0, "cost": 0, "telegramCode": "string", "telegramCodeTtlSeconds": 0, "telegramPayload": "string", "telegramSenderUsername": "string", "telegramUsePrecheck": true } ] }'

Update campaign

Request

Responses