API docs by Redocly

Cloud Campaign API (v1)

Download OpenAPI specification:

Agencies

List Agency Statistics

header Parameters
x-agency-id
required
string

Responses

List Agency Settings Deprecated

Superseded by the Retrieve Configuration Values endpoint.

path Parameters
agencyId
required
string

Responses

Authorization

Get Auth Token

Request Body schema: application/json
key
string
secret
string

Responses

Request samples

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

Configuration

Configurations allow you to customize a user's experience in the application. Configurations have a global default value and can be overridden at the Agency, Workspace, and User level. The most specific value will be utilized to define a user's experience, with user being the most specific. If you would like to modify configuration, we encourage applying defaults at the highest applicable level, likely at your Agency and then applying more specific overrides, if needed.

Example:

This example shows how overriding configuration operates in our system.

Scenario:

  • Configuration SOCIAL_ACCOUNTS_LIMIT has a default value of 10.
  • Your Agency has an override of configuration SOCIAL_ACCOUNTS_LIMIT with a value of 20.
  • The Workspace, Client 1, which is is part of your Agency has an override of configuration SOCIAL_ACCOUNTS_LIMIT with a value of 50.
  • The User, John, who is a member of your Agency has an override of configuration SOCIAL_ACCOUNTS_LIMIT with a value of 0.

Outcomes:

  • When configuration SOCIAL_ACCOUNTS_LIMIT is utilized in a different Agency without an override, the default value of 10 will be utilized.
    Default Value Agency Override Workspace Override User Override
    10
  • When configuration SOCIAL_ACCOUNTS_LIMIT is utilized by your Agency, the Agency override value of 20 will be utilized.
    Default Value Agency Override Workspace Override User Override
    10 20
  • When configuration SOCIAL_ACCOUNTS_LIMIT is utilized in your Agency in Workspace Client 1 for User Jane, the Workspace override value of 50 will be utilized.
    Default Value Agency Override Workspace Override User Override
    10 20 50
  • When configuration SOCIAL_ACCOUNTS_LIMIT is utilized in your Agency in Workspace Client 1 for User John, the User override value of 0 will be utilized.
    Default Value Agency Override Workspace Override User Override
    10 20 50 0

Retrieve Configuration Values

Retrieves the configuration values for a given Agency, Workspace, and/or User context.

query Parameters
workspaceId
string <uuid>
userId
string <uuid>
header Parameters
x-agency-id
required
string <uuid>

Responses

List Configuration Defaults

Lists the default configuration values. Utilize the Override Configuration endpoint to override these values.

header Parameters
x-agency-id
required
string <uuid>

Responses

Override Configuration

Creates a configuration override at the Agency, Workspace, or User level.

header Parameters
x-agency-id
required
string
Request Body schema: application/json
agencyId
required
string <uuid>

The agency to set the override for. If you provide only an agency the override will be set at the agency level.

workspaceId
string <uuid>

The workspace to set the override for. Allows a override to be overridden for a specific workspace. If you provide a workspace ID, you must not provide a user ID.

userId
string <uuid>

The user to set the override for. Allows a override to be overridden for a specific user. If you provide a user ID, you must not provide a workspace ID.

configurationId
required
integer <int32>

The ID of the configuration to override.

value
required
object

The value to override the configuration with. The data type of this value depends on the configuration you are overriding. See the List Configuration Defaults endpoint to identify the configuration data type. Example values include true or 14.

Responses

Request samples

Content type
application/json
{
  • "agencyId": "fe2a2303-ed4e-420e-a204-390681cd7c5b",
  • "workspaceId": "571e0499-6321-4a8a-ae91-7c1f6ae66cae",
  • "userId": "bca4a5cc-3e45-4fce-bdfe-b4e9d677a654",
  • "configurationId": 51,
  • "value": { }
}

Remove Configuration Override

Removes a setting override at the Agency, Workspace, or User level.

header Parameters
x-agency-id
required
string
Request Body schema: application/json
agencyId
required
string <uuid>

The agency to remove the override for. If you provide only an agency, the override will be removed at the agency level.

workspaceId
string <uuid>

The workspace to remove the override for. Allows a override to be overridden for a specific workspace. If you provide a workspace ID, you must not provide a user ID.

userId
string <uuid>

The user to remove the override for. Allows a override to be overridden for a specific user. If you provide a user ID, you must not provide a workspace ID.

configurationId
required
integer <int32>

The ID of the setting override to remove.

Responses

Request samples

Content type
application/json
{
  • "agencyId": "fe2a2303-ed4e-420e-a204-390681cd7c5b",
  • "workspaceId": "571e0499-6321-4a8a-ae91-7c1f6ae66cae",
  • "userId": "bca4a5cc-3e45-4fce-bdfe-b4e9d677a654",
  • "configurationId": 51
}

Content

Bulk Create Content Captions

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": [
    ]
}

Bulk Create Content from 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"
}

Create Content

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": [
    ]
}

Get Content

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

Responses

Content Tags

List Content Tags

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

Responses

Create Content Tag

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"
}

Schedules

Schedules allow content publishing to be pre-planned or even automated with certain schedule types.

Create a Schedule

header Parameters
x-agency-id
required
string
Request Body schema: application/json
workspaceId
required
string

The ID of the workspace to create the schedule in.

title
required
string

The title of the schedule.

active
boolean

Whether the schedule is active. Defaults to false.

type
string
Value: "WEEKLY"

The type of schedule to be created.

timezone
required
string

The timezone of the schedule. Utilizes IANA timezone database IDs, such as America/Denver.

object (ScheduleAutofillDTO)

The autofill configuration for the schedule. Autofilling automatically adds content to the schedule based on content tags.

required
Array of objects (ScheduleTimeslotDTO)

The timeslot configuration for the schedule.

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "3723d2d7-45cb-4ff7-af59-a3956fd9b25d",
  • "title": "Monday Motivation",
  • "active": true,
  • "type": "WEEKLY",
  • "timezone": "America/Denver",
  • "autoFill": {
    },
  • "weeklyTimeslots": [
    ]
}

Settings

List Settings Defaults Deprecated

Superseded by the List Configuration Defaults endpoint.

Responses

Social Accounts

List Disconnected Accounts

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

List Aggregate Account Metrics

header Parameters
x-agency-id
required
string

Responses

List Account Details

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

Responses

List Account Credentials

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

Responses

List Account Credential Statistics

header Parameters
x-agency-id
required
string

Responses

Users

List Users

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

Responses

Create User

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)
object (EmailSubscriptions)

Responses

Request samples

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

Get User

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

Responses

Update User

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)
object (EmailSubscriptions)

Responses

Request samples

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

Delete User

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

Responses

List User Settings Deprecated

Superseded by the Retrieve Configuration Values endpoint.

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

Responses

Add User Settings Deprecated

Superseded by the Override Configuration endpoint.

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
userId
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Remove User Settings Deprecated

Superseded by the Remove Configuration Override endpoint.

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
]

List User Workspaces

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

Add User to Workspace

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"
]

Remove User from Workspace

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"
]

List User Workspace Tags

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

Responses

Workspace Tags

List Workspace Tags

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

Responses

Create Workspace Tag

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"
}

Get Workspace Tag

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

Responses

Update Workspace Tag

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"
}

Delete Workspace Tag

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

Responses

List Workspace Tag Users

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

Responses

Add Users to Workspace Tag

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"
]

Remove Users from Workspace Tag

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"
]

List Workspace Tag Workspaces

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

Responses

Add Workspaces to Workspace Tag

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": [
    ]
}

Remove Workspaces from Workspace Tag

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"
]

Workspaces

List Workspaces

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

Responses

Create Workspace

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
}

Get Workspace

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

Responses

Update Workspace

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>
trialExpiration
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,
  • "trialExpiration": 0,
  • "active": true,
  • "agencyId": "string",
  • "externalId": "string",
  • "timezone": "string"
}

Delete Workspace

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

Responses

This endpoint will convert a trial workspace to an activated paid workspace.

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

Responses

Get Workspace Health Stats

This endpoint gets stats about the health and usage of a workspace.

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

Responses

Add Email to Notification Recipients

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

Responses

Request samples

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

Remove Email from Notification Recipients

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

Responses

Request samples

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

List Workspace Settings Deprecated

Superseded by the Retrieve Configuration Values endpoint.

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

Responses

Add Workspace Settings Deprecated

Superseded by the Override Configuration endpoint.

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
[
  • {
    }
]

Remove Workspace Settings Deprecated

Superseded by the Remove Configuration Override endpoint.

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
]

List Workspace Tags

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

Responses