Skip to main content
POST
/
Campaign
Create Campaign
curl --request POST \
  --url https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Campaign \
  --header 'Content-Type: application/json' \
  --header 'X-apikey: <api-key>' \
  --data '
{
  "Name": "",
  "ExternalId": "",
  "AccountId": 1234567891234567,
  "StartDate": "2014-12-31",
  "EndDate": "2014-12-31",
  "PartnerBudget": 0.1,
  "SalesProbability": 0.1,
  "CampaignBriefFields": [
    {
      "FieldName": "",
      "FieldValue": ""
    }
  ],
  "LineItems": [
    {
      "ExternalId": "",
      "LineItemName": "",
      "CampaignId": 1234567891234567,
      "ProductId": 1234567891234567,
      "StartDate": "2014-12-31",
      "EndDate": "2014-12-31",
      "Quantity": 0,
      "PartnerRate": 0.1,
      "FulfilmentCost": 0.1,
      "PartnerDiscount": 0,
      "LineItemReportingFields": [
        {
          "FieldName": "",
          "FieldValue": ""
        }
      ],
      "LineItemEvidence": [
        {
          "EvidenceFileName": "",
          "EvidenceURL": "",
          "EvidenceDescription": ""
        }
      ],
      "LineItemBriefFields": [
        {
          "FieldName": "",
          "FieldValue": ""
        }
      ],
      "EvidenceFilename_1": "",
      "EvidenceURL_1": "",
      "EvidenceFilename_2": "",
      "EvidenceURL_2": "",
      "EvidenceFilename_3": "",
      "EvidenceURL_3": "",
      "EvidenceFilename_4": "",
      "EvidenceURL_4": "",
      "EvidenceFilename_5": "",
      "EvidenceURL_5": "",
      "LineItemStatusId": 1234567891234567,
      "CostBasis_Override": ""
    }
  ],
  "SourceMarket": 1234567891234567,
  "ContractSigned": false,
  "CampaignStatusId": 1234567891234567
}
'
{
  "Success": false,
  "Message": "",
  "Id": 1234567891234567,
  "ExternalId": "",
  "LineItems": [
    {
      "Success": false,
      "Message": "",
      "Id": 1234567891234567,
      "ExternalId": ""
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://platform195.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-apikey
string
header
required

Body

application/json
Name
string
default:""
ExternalId
string
default:""
AccountId
integer<int64>
Example:

1234567891234567

StartDate
string<date>
Example:

"2014-12-31"

EndDate
string<date>
Example:

"2014-12-31"

PartnerBudget
number
Example:

0.1

SalesProbability
number
Example:

0.1

CampaignBriefFields
object[]
LineItems
object[]
SourceMarket
integer<int64>
Example:

1234567891234567

ContractSigned
boolean
Example:

false

CampaignStatusId
integer<int64>
Example:

1234567891234567

Response

200 - application/json
Success
boolean
required
Example:

false

Message
string
default:""
required
Id
integer<int64>
Example:

1234567891234567

ExternalId
string
default:""
LineItems
object[]