Update a campaign

PATCH

https://api.hmsovereign.com/api/v1/campaigns/{id}

Campaigns

Last modified:2026-01-30 13:43:45

Maintainer:Jesper Rietbergen

Update campaign settings or status. Set status to scheduled to start calling.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Campaign updated

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.hmsovereign.com/api/v1/campaigns/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "status": "draft",
    "system_message_template": "string",
    "schedule_start_time": "string",
    "schedule_end_time": "string",
    "timezone": "string"
}'

Response Example

{
    "campaign": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "Q1 Sales Outreach",
        "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
        "status": "draft",
        "system_message_template": "You are calling {{name}} from {{company}}. Convince them to schedule a demo.",
        "schedule_start_time": "09:00:00",
        "schedule_end_time": "17:00:00",
        "timezone": "Europe/Amsterdam",
        "total_leads": 0,
        "completed_leads": 0,
        "failed_leads": 0,
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-01-30 13:43:45

Get a campaign

Delete a campaign