PlusVibe.ai

Set campaign Schedules

POST

https://api.plusvibe.ai/api/v1/campaign/set/schedules

Campaign

Sets one or more schedules for your campaign.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.plusvibe.ai/api/v1/campaign/set/schedules' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaign_id": "66b447598f6dd99f7f7b5c0a",
    "workspace_id": "65f3c92d3dbe5dbb35374a9a",
    "start_date": "2024-01-01",
    "end_date": "2019-08-24",
    "schedules": [
        {
            "days": {
                "1": true,
                "2": true,
                "3": true,
                "4": true,
                "5": true
            },
            "timezone": "Asia/Hong_Kong",
            "timing": {
                "from": "09:00",
                "to": "18:00"
            }
        }
    ]
}'

Response Example

200 - Example 1

{
    "status": "success"
}

Request

Header Params

x-api-key

string

required

Your PlusVibe.ai account's API Key

Default:

Example:

your-api-key

Body Params application/json

campaign_id

string

required

The unique identifier of the campaign.

Example:

66b447598f6dd99f7f7b5c0a

workspace_id

string

required

Workspace ID

Example:

65f3c92d3dbe5dbb35374a9a

start_date

string <date>

optional

The date when the schedule should start. Optional. Do not pass this in requst body if you do not want to set a start date.

Example:

2024-01-01

end_date

string <date>

optional

The date when the schedule should end. Optional. Do not pass this in requst body if you do not want to set an end date.

schedules

array [object {3}]

required

An array of schedule objects defining the days, timezone, and timing for the campaign.

days

object

required

An object defining which days the schedule is active. Keys are day numbers (1 for Monday, 2 for Tuesday, etc.), and values are booleans indicating whether the day is active.

timezone

string

required

The timezone in which the schedule should be applied. For a list of supported timezone, visit: https://help.plusvibe.ai/en/articles/9734335-time-zone-supported-in-campaign-set-schedules-endpoint

Example:

Asia/Hong_Kong

timing

object

required

The time range during which the campaign should be active on the specified days.

Examples

Responses

🟢200OK

application/json

Successful

Body

status

string

optional

Example:

success

🟠400Bad Request

🔴500Server Error

Modified at 2025-05-24 05:40:10

Set campaign name

Activate campaign