Create a campaign

PUT /campaign

Body

The campaign to create

name string Required
description string Required
businessName string Required
businessId string Required
startDate string Required
endDate string
geo array Required
files array Required

Responses

200

The campaign updated from the request
Hide response attributes Show response attributes object
- campaignId string Required
  
  The unique identifier of a campaign
- name string Required
- description string Required
- business object Required
- startDate object Required
- endDate object
- geo array Required
- files array Required
- status string
- reporting string
- timestamp number
400

Client error
Hide response attribute Show response attribute object
- message string Required
  
  A human readable error message

PUT /campaign

curl \
 -X PUT https://api.spotlumos.com/campaign \
 -H "X-API-KEY: $API_KEY" \
 -d '{"name":"string","description":"string","businessName":"string","businessId":"string","startDate":"string","endDate":"string","geo":[],"files":[]}'

Request example

{
  "name": "string",
  "description": "string",
  "businessName": "string",
  "businessId": "string",
  "startDate": "string",
  "endDate": "string",
  "geo": [],
  "files": []
}

Request examples

{
  "name": "string",
  "description": "string",
  "businessName": "string",
  "businessId": "string",
  "startDate": "string",
  "endDate": "string",
  "geo": [],
  "files": []
}

Response examples (200)

{
  "campaignId": "string",
  "name": "string",
  "description": "string",
  "business": {},
  "startDate": {},
  "endDate": {},
  "geo": [],
  "files": [],
  "status": "string",
  "reporting": "string",
  "timestamp": 42.0
}

Response examples (200)

{
  "campaignId": "string",
  "name": "string",
  "description": "string",
  "business": {},
  "startDate": {},
  "endDate": {},
  "geo": [],
  "files": [],
  "status": "string",
  "reporting": "string",
  "timestamp": 42.0
}

Response examples (400)

{
  "message": "string"
}

Response examples (400)

{
  "message": "string"
}