Skip to main content
PATCH
/
campaigns
/
{campaignId}
Update campaign
curl --request PATCH \
  --url https://api.getarbol.com/v1/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "scheduledFor": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "metadata": {}
}
'
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "requestId": "<string>"
}

Authorizations

Authorization
string
header
required

Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.

Path Parameters

campaignId
string
required

Campaign ID (cmp_ prefix)

Body

application/json
name
string
description
string
scheduledFor
string<date-time>
timezone
string
metadata
object

Response

Updated campaign