curl --request POST \
--url https://your-sift-api-url.com/api/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"tags": {
"ids": {
"ids": [
"<string>"
]
},
"names": {
"names": [
"<string>"
]
}
},
"organizationId": "<string>",
"clientKey": "<string>",
"createFrom": {
"reports": {
"ids": {
"ids": [
"<string>"
]
},
"clientKeys": {
"clientKeys": [
"<string>"
]
}
},
"runs": {
"ids": {
"ids": [
"<string>"
]
},
"clientKeys": {
"clientKeys": [
"<string>"
]
}
},
"otherCampaign": {
"id": "<string>",
"clientKey": "<string>"
}
},
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
'{
"campaign": {
"campaignId": "<string>",
"name": "<string>",
"organizationId": "<string>",
"clientKey": "<string>",
"description": "<string>",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"archivedDate": "2023-11-07T05:31:56Z",
"tags": [
{
"tagId": "<string>",
"name": "<string>"
}
],
"reports": [
{
"reportId": "<string>",
"reportName": "<string>",
"numAnnotations": 123,
"numPassedRules": 123,
"numAcceptedRules": 123,
"numFailedRules": 123,
"numOpenRules": 123
}
],
"createdFromCampaignId": "<string>",
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
}Create a campaign.
curl --request POST \
--url https://your-sift-api-url.com/api/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"tags": {
"ids": {
"ids": [
"<string>"
]
},
"names": {
"names": [
"<string>"
]
}
},
"organizationId": "<string>",
"clientKey": "<string>",
"createFrom": {
"reports": {
"ids": {
"ids": [
"<string>"
]
},
"clientKeys": {
"clientKeys": [
"<string>"
]
}
},
"runs": {
"ids": {
"ids": [
"<string>"
]
},
"clientKeys": {
"clientKeys": [
"<string>"
]
}
},
"otherCampaign": {
"id": "<string>",
"clientKey": "<string>"
}
},
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
'{
"campaign": {
"campaignId": "<string>",
"name": "<string>",
"organizationId": "<string>",
"clientKey": "<string>",
"description": "<string>",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"archivedDate": "2023-11-07T05:31:56Z",
"tags": [
{
"tagId": "<string>",
"name": "<string>"
}
],
"reports": [
{
"reportId": "<string>",
"reportName": "<string>",
"numAnnotations": 123,
"numPassedRules": 123,
"numAcceptedRules": 123,
"numFailedRules": 123,
"numOpenRules": 123
}
],
"createdFromCampaignId": "<string>",
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The request of a call to CampaignService_CreateCampaign to create a campaign.
The request of a call to CampaignService_CreateCampaign to create a campaign.
Show child attributes
User-specified unique identifier.
Campaigns can be created from a few different sources.
Show child attributes
Show child attributes
A successful response.
The response of a call to CampaignService_CreateCampaign to create a campaign.
Show child attributes
Was this page helpful?