API Documentation
- API Overview
- Events
- Organization
- User
- Auth
- Organization Members
- Contacts
- Lists
- Campaigns
- Conversations
- Messages
- Integrations
- Analytics
- Knowledge Base
- System
Campaigns
Post campaigns 1
modify campaign data
POST
/
campaigns
/
{id}
Copy
curl --request POST \
--url https://api.wapikit.com/api/campaigns/{id} \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"description": "<string>",
"listIds": [
"<string>"
],
"templateMessageId": "<string>",
"enableLinkTracking": true,
"tags": [
"<string>"
],
"status": "Draft",
"phoneNumber": "<string>",
"templateComponentParameters": {
"header": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"body": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"buttons": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"catalogId": "<string>",
"productRetailerId": "<string>",
"productSections": [
{
"title": "<string>",
"productItems": [
{
"productRetailerId": "<string>"
}
]
}
]
},
"scheduledAt": "2023-11-07T05:31:56Z"
}'
Copy
{
"isUpdated": true
}
Path Parameters
The id of campaign to update
Body
application/json
updated campaign info
The body is of type object
.
Response
200
application/json
returns updated campaign.
The response is of type object
.
Was this page helpful?
Copy
curl --request POST \
--url https://api.wapikit.com/api/campaigns/{id} \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"description": "<string>",
"listIds": [
"<string>"
],
"templateMessageId": "<string>",
"enableLinkTracking": true,
"tags": [
"<string>"
],
"status": "Draft",
"phoneNumber": "<string>",
"templateComponentParameters": {
"header": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"body": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"buttons": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"catalogId": "<string>",
"productRetailerId": "<string>",
"productSections": [
{
"title": "<string>",
"productItems": [
{
"productRetailerId": "<string>"
}
]
}
]
},
"scheduledAt": "2023-11-07T05:31:56Z"
}'
Copy
{
"isUpdated": true
}
Assistant
Responses are generated using AI and may contain mistakes.