API docs by Redocly

Cloud Campaign API (v1)

Download OpenAPI specification:

AuthController

token

Request Body schema: application/json
key
string
secret
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "secret": "string"
}

CaptionaiController

bulkCreateCaptionsAndContent

header Parameters
x-agency-id
required
string
Request Body schema: application/json
prompt
string
workspaceIds
Array of strings
quantity
integer <int32>
includeHashtags
boolean
includeEmojis
boolean
tone
string
variability
number <double>
requireApproval
boolean
categories
Array of strings
platformList
Array of strings

Responses

Request samples

Content type
application/json
{
  • "prompt": "string",
  • "workspaceIds": [
    ],
  • "quantity": 0,
  • "includeHashtags": true,
  • "includeEmojis": true,
  • "tone": "string",
  • "variability": 0.1,
  • "requireApproval": true,
  • "categories": [
    ],
  • "platformList": [
    ]
}

ContentController

Bulk Create Content from a CSV

This endpoint enables bulk content creation from a CSV file. The CSV file format can be found in our knowledge base documentation.

header Parameters
x-agency-id
required
string
Request Body schema: application/json
agencyId
required
string
workspaceIds
Array of strings [ 1 .. 100 ] items
externalUrl
required
string

Responses

Request samples

Content type
application/json
{
  • "agencyId": "string",
  • "workspaceIds": [
    ],
  • "externalUrl": "string"
}

createContent

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
title
string
isCoverPhoto
boolean
isStory
boolean
approved
boolean
object (ContentCreatePubSettingRequest)
tagNames
Array of strings
platformList
Array of strings
Array of objects (CaptionCreateRequest)
Array of objects (ContentCreateMediaRequest)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "isCoverPhoto": true,
  • "isStory": true,
  • "approved": true,
  • "publishingSettings": {
    },
  • "tagNames": [
    ],
  • "platformList": [
    ],
  • "captions": [
    ],
  • "media": [
    ]
}

readContent

path Parameters
workspaceId
required
string
contentId
required
string
header Parameters
x-agency-id
required
string

Responses

listContentTags

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string

Responses

createContentTag

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
color
string
id
string
object (Style)
title
string
workspaceId
string

Responses

Request samples

Content type
application/json
{
  • "color": "string",
  • "id": "string",
  • "style": {
    },
  • "title": "string",
  • "workspaceId": "string"
}

EntityController

getAgencyStats

header Parameters
x-agency-id
required
string

Responses

getWorkspaces

query Parameters
page
integer <int32>
Default: 0
pageSize
integer <int32> [ 1 .. 100 ]
Default: 100
header Parameters
x-agency-id
required
string

Responses

createWorkspace

header Parameters
x-agency-id
required
string
Request Body schema: application/json
agencyId
string
externalId
string
timezone
string
name
string
website
string
iconUrl
string
active
boolean

Responses

Request samples

Content type
application/json
{
  • "agencyId": "string",
  • "externalId": "string",
  • "timezone": "string",
  • "name": "string",
  • "website": "string",
  • "iconUrl": "string",
  • "active": true
}

getWorkspaceById

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string

Responses

updateWorkspace

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
id
string
name
string
website
string
iconUrl
string
dateActivated
integer <int64>
dateDeactivated
integer <int64>
active
boolean
agencyId
string
externalId
string
timezone
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "website": "string",
  • "iconUrl": "string",
  • "dateActivated": 0,
  • "dateDeactivated": 0,
  • "active": true,
  • "agencyId": "string",
  • "externalId": "string",
  • "timezone": "string"
}

deleteWorkspace

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string

Responses

addToRecipientList

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
email
string
list
string
Enum: "APPROVALS" "REPORTS"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "list": "APPROVALS"
}

removeFromRecipientList

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
email
string
list
string
Enum: "APPROVALS" "REPORTS"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "list": "APPROVALS"
}

getWorkspaceTagsForWorkspace

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string

Responses

ScheduleController

createSchedule

header Parameters
x-agency-id
required
string
Request Body schema: application/json
workspaceId
string
title
string
active
boolean
type
string
Enum: "SCHEDULED" "AD_HOC" "WEEKLY"
timezone
string
object (ScheduleAutofillDTO)
Array of objects (ScheduleTimeslotDTO)

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "string",
  • "title": "string",
  • "active": true,
  • "type": "SCHEDULED",
  • "timezone": "string",
  • "autoFill": {
    },
  • "weeklyTimeslots": [
    ]
}

SettingsController

getSettingsForAgency Deprecated

path Parameters
agencyId
required
string

Responses

getSettings

header Parameters
x-agency-id
required
string

Responses

getSettingsForUser

path Parameters
userId
required
string
header Parameters
x-agency-id
required
string

Responses

addUserSettings

path Parameters
userId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
Array
id
integer <int32>
settingId
integer <int32>
value
string
categoryId
integer <int32>
clazz
string
type
string
Enum: "STRING" "ENUM" "COMPLEX" "INTEGER" "LONG" "DOUBLE" "BOOLEAN"
settingName
string
categoryName
string
agencyId
string
workspaceId
string
userId
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

removeUserSettings

path Parameters
userId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
Array
integer <int32>

Responses

Request samples

Content type
application/json
[
  • 0
]

getSettingsForWorkspace

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string

Responses

createSettingForWorkspace

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
Array
id
integer <int32>
settingId
integer <int32>
value
string
categoryId
integer <int32>
clazz
string
type
string
Enum: "STRING" "ENUM" "COMPLEX" "INTEGER" "LONG" "DOUBLE" "BOOLEAN"
settingName
string
categoryName
string
workspaceId
string
agencyId
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

removeSettingsForWorkspace

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
Array
integer <int32>

Responses

Request samples

Content type
application/json
[
  • 0
]

SocialMediaController

getDisconnectedPlatformAccounts

path Parameters
accountType
required
string
Enum: "FACEBOOK" "LINKEDIN" "GMB" "INSTAGRAM" "YOUTUBE" "PINTEREST" "TIKTOK" "THREADS" "OTHER" "STORIES" "SNAPCHAT" "CLUBHOUSE" "TUMBLR" "REDDIT" "EMAIL" "TWITTER" "GOOGLE_PLUS" "GOOGLE_DRIVE" "GOOGLE_ANALYTICS" "GOOGLE_ANALYTICS4" "BUFFER" "FACEBOOK_ADS"
header Parameters
x-agency-id
required
string

Responses

getAggregateAnalytics

header Parameters
x-agency-id
required
string

Responses

getPlatformCredentialStatistics Deprecated

header Parameters
x-agency-id
required
string

Responses

getAccountDetailsForWorkspace

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string

Responses

getAccountCredentialDetailsForWorkspace

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string

Responses

getPlatformCredentialStats

header Parameters
x-agency-id
required
string

Responses

UserControllerV1

getUsersForAgency

query Parameters
page
integer <int32>
Default: 0
pageSize
integer <int32> [ 1 .. 100 ]
Default: 100
header Parameters
x-agency-id
required
string

Responses

createUser

header Parameters
x-agency-id
required
string
Request Body schema: application/json
agencyId
string
externalId
string
name
string
email
string
role
required
string
Enum: "BRAND_MANAGER" "BRAND_ADMIN" "CLIENT" "CONTENT_CREATOR" "PUBLISHER" "ADMIN" "BRAND_AMBASSADOR" "SUBSCRIBER"
Array of objects (UserSettingValue)

Responses

Request samples

Content type
application/json
{
  • "agencyId": "string",
  • "externalId": "string",
  • "name": "string",
  • "email": "string",
  • "role": "BRAND_MANAGER",
  • "settings": [
    ]
}

getUserById

path Parameters
userId
required
string
header Parameters
x-agency-id
required
string

Responses

updateUser

path Parameters
userId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
id
string
agencyId
string
externalId
string
name
string
email
string
role
string
Enum: "BRAND_MANAGER" "BRAND_ADMIN" "CLIENT" "CONTENT_CREATOR" "PUBLISHER" "ADMIN" "BRAND_AMBASSADOR" "SUBSCRIBER"
Array of objects (UserSettingValue)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "agencyId": "string",
  • "externalId": "string",
  • "name": "string",
  • "email": "string",
  • "role": "BRAND_MANAGER",
  • "settings": [
    ]
}

deleteUser

path Parameters
userId
required
string
header Parameters
x-agency-id
required
string

Responses

getWorkspacesForUser

path Parameters
userId
required
string
query Parameters
page
integer <int32>
Default: 0
pageSize
integer <int32> [ 1 .. 100 ]
Default: 100
header Parameters
x-agency-id
required
string

Responses

addUserToWorkspaces

path Parameters
userId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

removeUserFromWorkspaces

path Parameters
userId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

getWorkspaceTagsForUser

path Parameters
userId
required
string
header Parameters
x-agency-id
required
string

Responses

WorkspaceTagController

listWorkspaceTags

query Parameters
page
required
integer <int32>
pageSize
required
integer <int32>
header Parameters
x-agency-id
required
string

Responses

addWorkspaceTag

header Parameters
x-agency-id
required
string
Request Body schema: application/json
id
string
agencyId
string
name
string
color
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "agencyId": "string",
  • "name": "string",
  • "color": "string"
}

getById

path Parameters
workspaceTagId
required
string
header Parameters
x-agency-id
required
string

Responses

updateWorkspaceTag

path Parameters
workspaceTagId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
id
string
agencyId
string
name
string
color
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "agencyId": "string",
  • "name": "string",
  • "color": "string"
}

deleteWorkspaceTag

path Parameters
workspaceTagId
required
string
header Parameters
x-agency-id
required
string

Responses

listUserIds

path Parameters
workspaceTagId
required
string
query Parameters
page
required
integer <int32>
pageSize
required
integer <int32>
header Parameters
x-agency-id
required
string

Responses

addUsersToWorkspaceTag

path Parameters
workspaceTagId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

removeUserFromWorkspaceTag

path Parameters
workspaceTagId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

listWorkspaceIds

path Parameters
workspaceTagId
required
string
query Parameters
page
required
integer <int32>
pageSize
required
integer <int32>
header Parameters
x-agency-id
required
string

Responses

addWorkspacesToWorkspaceTag

path Parameters
workspaceTagId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
selectAll
boolean
excludedWorkspaceIds
Array of strings
workspaceIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "selectAll": true,
  • "excludedWorkspaceIds": [
    ],
  • "workspaceIds": [
    ]
}

removeWorkspacesFromWorkspaceTag

path Parameters
workspaceTagId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]