Skip to main content
POST
/
pique-campaign
Create Pique Campaign
curl --request POST \
  --url https://api.ubpass.co/v1/pique-campaign \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "type": "BoostedPost",
  "targetViews": 123,
  "platforms": [
    "<string>"
  ],
  "deliveredViews": 123,
  "contentLink": "<string>",
  "submissionNotes": "<string>",
  "endDate": "2023-12-25"
}'
{
  "id": "<string>",
  "createdTime": "2025-05-13T15:07:15.036Z",
  "updatedTime": "2025-05-13T15:07:15.036Z",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "workspaceId": "<string>",
  "accountId": "<string>",
  "name": "<string>",
  "type": "BoostedPost",
  "status": "Prepping",
  "startDate": "2023-12-25",
  "isPublished": true,
  "campaignData": {
    "id": "<string>",
    "createdTime": "2025-05-13T15:07:15.036Z",
    "updatedTime": "2025-05-13T15:07:15.036Z",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "workspaceId": "<string>",
    "campaignId": "<string>",
    "totalViews": 123,
    "totalClicks": 123,
    "totalLikes": 123,
    "totalCreators": 123,
    "totalComments": 123,
    "totalShares": 123,
    "totalVideos": 123,
    "instagramViews": 123,
    "instagramLikes": 123,
    "instagramShares": 123,
    "instagramComments": 123,
    "tiktokViews": 123,
    "tiktokLikes": 123,
    "tiktokShares": 123,
    "tiktokComments": 123,
    "assetFolderLink": "<string>",
    "rec1": "<string>",
    "rec2": "<string>",
    "rec3": "<string>",
    "rec4": "<string>"
  },
  "campaignDataFileInfo": {
    "fileKey": "<string>",
    "fileName": "<string>",
    "url": "<string>"
  },
  "videoPerformanceFileInfo": {
    "fileKey": "<string>",
    "fileName": "<string>",
    "url": "<string>"
  },
  "platforms": [
    "<string>"
  ],
  "targetViews": 123,
  "beforeViews": 123,
  "afterViews": 123,
  "deliveredViews": 123,
  "contentLink": "<string>",
  "submissionNotes": "<string>",
  "endDate": "2023-12-25",
  "beforeImage": {
    "fileKey": "<string>",
    "fileName": "<string>",
    "url": "<string>"
  },
  "afterImage": {
    "fileKey": "<string>",
    "fileName": "<string>",
    "url": "<string>"
  }
}

Authorizations

api-key
string
header
required

API Key authentication

Headers

x-workspace-id
string

Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user

Body

application/json

Request body for creating Pique Campaign

name
string
type
enum<string>
Available options:
BoostedPost,
SyndicatedContent
targetViews
integer
platforms
string[]
deliveredViews
integer
submissionNotes
string
endDate
string<date>

Response

Campaign created successfully

id
string
createdTime
string<date-time>

The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

updatedTime
string<date-time>

The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

createdBy
string

The user who created the entity.

updatedBy
string

The user who last updated the entity.

workspaceId
string

The ID of the workspace to which this entity belongs.

accountId
string
name
string
type
enum<string>
Available options:
BoostedPost,
SyndicatedContent
status
enum<string>
Available options:
Prepping,
InProgress,
Completed,
Paused,
NotStarted,
Cancelled
startDate
string<date>
isPublished
boolean
campaignData
object
campaignDataFileInfo
object
videoPerformanceFileInfo
object
platforms
string[]
targetViews
integer
beforeViews
integer
afterViews
integer
deliveredViews
integer
submissionNotes
string
endDate
string<date>
beforeImage
object
afterImage
object