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

CloudStudio

Activate CloudStudio

Activates CloudStudio on 1-100 workspaces in the agency. Activation is an upsert: a workspace that already has CloudStudio is re-pointed to the requested plan and posting-frequency override, so re-invoking this endpoint is the supported way to change them; re-activation refreshes activatedAt. Any approved campaign brief is unapproved so content under the new plan starts from a fresh approval. Duplicate workspaceIds are coalesced. Plan codes: CLOUDSTUDIO_1 = The Social Media Manager 3 posts/week, CLOUDSTUDIO_2 = 7 posts/week, CLOUDSTUDIO_3 = 14 posts/week, CLOUDSTUDIO_4 = The Whole Damn Agency 28 posts/week. postFrequencyCountOverride must be between 1 and the plan's cadence; out-of-range values are rejected with 400.

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

1-100 distinct workspace IDs (UUID strings) to activate. Duplicates are coalesced.

planCode
required
string
Enum: "CLOUDSTUDIO_1" "CLOUDSTUDIO_2" "CLOUDSTUDIO_3" "CLOUDSTUDIO_4"

The CloudStudio plan to activate.

postFrequencyCountOverride
integer <int32> >= 1

Posts per week, 1 to the plan's cadence. Omit to use the plan's cadence.

Responses

Request samples

Content type
application/json
{
  • "workspaceIds": [
    ],
  • "planCode": "CLOUDSTUDIO_1",
  • "postFrequencyCountOverride": 1
}

Generate sample content

Generates the workspace's one-time CloudStudio sample content batch: unscheduled draft posts gathered under a content approval. Supply brandInfo.brandWebsite to have empty brand details filled from the website (request values always win), or brandInfo.brandName with the details you want used. The request is validated and accepted with 202; generation runs asynchronously and completes or fails through the SAMPLE_CONTENT_READY_FOR_REVIEW and SAMPLE_CONTENT_GENERATION_FAILED webhooks, correlated by workspaceId. Nobody is emailed unless notificationRecipients names someone. A workspace receives exactly one sample batch.

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

The workspace to generate sample content for. Must belong to the agency in x-agency-id.

postCount
integer <int32> >= 1

Number of posts to generate, 1 to the workspace's sample content count setting (default 10). Omit to use the setting's value.

requiresApproval
boolean

Whether the generated posts wait for customer approval. Default true.

language
string

Locale code for captions, in-image text, and the campaign brief. Default en-US.

accountIds
Array of strings

Workspace social account IDs to attach the posts to. Omit for unattached posts. Each must belong to the workspace and be on a platform CloudStudio supports; an account on any other platform is rejected with 400 and the response names the supported platforms.

required
object (SampleBrandInfo)

Brand identity and campaign brief inputs. In website mode every empty field except fontFamily may be filled from the website.

object (SampleContactInfo)

Contact details by type. All four are required when a chosen graphic collection renders contact details into its templates.

object (SampleCaptionSettings)

Settings that apply to every caption.

object (SampleImageSettings)

Settings that apply to every image, whatever its style.

required
object (SampleImageStyles)

Each key is an image style; a key's presence chooses that style. At least one is required. Omitted percentages share the remainder evenly.

notificationRecipients
Array of strings [ 0 .. 20 ] items

Email addresses that receive the sample-ready email. Omitted or empty means nobody is emailed. Applies to this batch only; the workspace's CloudStudio recipient setting is not changed.

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "string",
  • "postCount": 1,
  • "requiresApproval": true,
  • "language": "en-US",
  • "accountIds": [
    ],
  • "brandInfo": {
    },
  • "contactInfo": {
    },
  • "captionSettings": {
    },
  • "imageSettings": {
    },
  • "imageStyles": {
    },
  • "notificationRecipients": [
    ]
}

List graphic style collections

Lists the graphic style collections available to the agency, ordered by name. Without a workspaceId, only collections not scoped to specific workspaces are listed. With a workspaceId, collections scoped to that workspace are added. Each collection's moods and industries are the distinct tags across its templates. Pages are zero-based: the page defaults to 0 and the page size defaults to 25, with a maximum of 100.

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

Responses

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 Deprecated

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

Generate Content

This restricted endpoint supports generating images and captions in multiple Workspaces at the same time. Contact your account manager to get access.

header Parameters
x-agency-id
required
string
Request Body schema: application/json
prompt
string
workspaceIds
Array of strings
quantity
integer <int32>
variability
number <double>
requireApproval
boolean
categories
Array of strings
location
string
industry
string
audience
string
services
Array of strings
brandVoices
Array of strings
required
object (GenerateCaptionsRequest)
object (GenerateMediaRequest)
bypassWorkspaceProfiles
boolean

Responses

Request samples

Content type
application/json
{
  • "prompt": "string",
  • "workspaceIds": [
    ],
  • "quantity": 0,
  • "variability": 0.1,
  • "requireApproval": true,
  • "categories": [
    ],
  • "location": "string",
  • "industry": "string",
  • "audience": "string",
  • "services": [
    ],
  • "brandVoices": [
    ],
  • "captions": {
    },
  • "media": {
    },
  • "bypassWorkspaceProfiles": true
}

Create Content

This endpoint enables creation of new Content. The boolean flag postNow can be used to create content and post it as soon as the supplied media has been uploaded. Set accountIds to post to specific accounts otherwise the workspace's default accounts will be used.

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)
postNow
boolean
accountIds
Array of strings

Responses

Request samples

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

Get Content

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

Responses

Publish Existing Content

This endpoint enables publishing of existing Content. An array of accountIds can be supplied in the body of the request. If no accountIds are supplied, the default accounts for the Content will be used.

path Parameters
workspaceId
required
string
contentId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
accountIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "accountIds": [
    ]
}

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 Deprecated

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 for WEEKLY schedules, true for AD_HOC.

type
required
string
Enum: "WEEKLY" "AD_HOC"

The type of schedule to be created.

timezone
string

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

object (ScheduleAutofillRequestDTO)

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

Array of objects (ScheduleTimeslotRequestDTO)

The timeslot configuration for the schedule. Required for WEEKLY type.

object (ScheduleAdHocPostRequestDTO)

Ad-hoc post configuration for AD_HOC schedules

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": [
    ],
  • "post": {
    }
}

Get Calendar Schedule

This endpoint will retrieve information about the calculated schedule for the Calendar for a given range of time.

path Parameters
workspaceId
required
string
query Parameters
startDate
required
integer <int64>
endDate
required
integer <int64>
platform
string
header Parameters
x-agency-id
required
string

Responses

List Schedules

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

Responses

Create a Schedule

path Parameters
workspaceId
required
string
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 for WEEKLY schedules, true for AD_HOC.

type
required
string
Enum: "WEEKLY" "AD_HOC"

The type of schedule to be created.

timezone
string

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

object (ScheduleAutofillRequestDTO)

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

Array of objects (ScheduleTimeslotRequestDTO)

The timeslot configuration for the schedule. Required for WEEKLY type.

object (ScheduleAdHocPostRequestDTO)

Ad-hoc post configuration for AD_HOC schedules

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": [
    ],
  • "post": {
    }
}

Settings

List Settings Defaults Deprecated

Superseded by the List Configuration Defaults endpoint.

Responses

Social Accounts

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

Send Direct Message

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

Platform account ID of who to send the message to.

from
required
string

Platform account ID of the account you are sending the message from.

parentId
string

The ID of the specific message you are replying to for a threaded response.

message
string
Array of objects (DirectMessageAttachmentRequest) [ 0 .. 30 ] items
platform
required
string
Value: "facebook"

The platform you are sending a message on.

Responses

Request samples

Content type
application/json
{
  • "to": "string",
  • "from": "string",
  • "parentId": "string",
  • "message": "string",
  • "attachments": [
    ],
  • "platform": "facebook"
}

Generates anonymous relink url for a specific platform.

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
platform
required
string
Enum: "FACEBOOK" "LINKEDIN" "GMB" "INSTAGRAM" "YOUTUBE" "PINTEREST" "TIKTOK" "THREADS"

The platform type for which to generate a relink URL

Responses

Request samples

Content type
application/json
{
  • "platform": "FACEBOOK"
}

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" "CLIENT" "ADMIN"
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
trialExpirationDays
integer <int32>

Optional free trial duration expressed as an integer between 1 and 30. Contact your account manager to enable this capability and to be considered for a longer trial length.

Responses

Request samples

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

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

Must match the workspaceId in the path.

agencyId
string
name
string
website
string
iconUrl
string
active
boolean
externalId
string
timezone

Responses

Request samples

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

Delete Workspace

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

Responses

Convert Trial Workspace

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

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

Responses

Request samples

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

Get Workspace Profile

Loads the workspace profile for the given workspace ID.

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

Responses

Save Workspace Profile

PUT the workspace profile for the given workspace ID with the passed in payload. These values are used to provide brand context for AI generated content.

path Parameters
workspaceId
required
string
header Parameters
x-agency-id
required
string
Request Body schema: application/json
brandVoices
Array of strings
industry
string
location
string
services
Array of strings
audience
string
phoneNumber
string
address
string

Responses

Request samples

Content type
application/json
{
  • "brandVoices": [
    ],
  • "industry": "string",
  • "location": "string",
  • "services": [
    ],
  • "audience": "string",
  • "phoneNumber": "string",
  • "address": "string"
}

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