Update campaign
curl --request PATCH \
--url https://www.carstoragesoftware.com/api/v1/marketing/campaigns/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"status": "<string>",
"type": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"socialEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"tags": [
"<string>"
],
"goal": "<string>",
"targetAudienceSize": 123
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
status: '<string>',
type: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
socialEventId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {tags: ['<string>'], goal: '<string>', targetAudienceSize: 123}
})
};
fetch('https://www.carstoragesoftware.com/api/v1/marketing/campaigns/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://www.carstoragesoftware.com/api/v1/marketing/campaigns/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"status": "<string>",
"type": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"socialEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"tags": ["<string>"],
"goal": "<string>",
"targetAudienceSize": 123
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"type": "<string>",
"channel": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"socialEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastRunAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": null
}
}{
"error": "<string>",
"code": "<string>",
"details": null
}{
"error": "<string>",
"code": "<string>",
"details": null
}{
"error": "<string>",
"code": "<string>",
"details": null
}{
"error": "<string>",
"code": "<string>",
"details": null
}Campaigns
Update campaign
Requires write:campaigns. Updates draft fields only. Rejects lifecycle statuses (active/scheduled/paused) — use /schedule, /send, /cancel, /pause, /resume.
PATCH
/
api
/
v1
/
marketing
/
campaigns
/
{id}
Update campaign
curl --request PATCH \
--url https://www.carstoragesoftware.com/api/v1/marketing/campaigns/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"status": "<string>",
"type": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"socialEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"tags": [
"<string>"
],
"goal": "<string>",
"targetAudienceSize": 123
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
status: '<string>',
type: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
socialEventId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {tags: ['<string>'], goal: '<string>', targetAudienceSize: 123}
})
};
fetch('https://www.carstoragesoftware.com/api/v1/marketing/campaigns/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://www.carstoragesoftware.com/api/v1/marketing/campaigns/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"status": "<string>",
"type": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"socialEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"tags": ["<string>"],
"goal": "<string>",
"targetAudienceSize": 123
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"type": "<string>",
"channel": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"socialEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastRunAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": null
}
}{
"error": "<string>",
"code": "<string>",
"details": null
}{
"error": "<string>",
"code": "<string>",
"details": null
}{
"error": "<string>",
"code": "<string>",
"details": null
}{
"error": "<string>",
"code": "<string>",
"details": null
}Authorizations
Team API key from Settings → Integrations. Use Authorization: Bearer <key> or x-api-key.
Path Parameters
Body
application/json
Response
Updated.
Show child attributes
Show child attributes
Was this page helpful?
⌘I