Cloud Campaign API (v1)

Superseded by the Retrieve Configuration Values endpoint.

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.

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 CONTENT_READY_FOR_REVIEW and CONTENT_GENERATION_FAILED webhooks, each with runType SAMPLE, correlated by workspaceId. Nobody is emailed unless notificationRecipients names someone. A workspace receives exactly one sample batch. Retrieve its status and, once it is finished, its provisional content and approval links from GET /api/v1/cloudstudio/workspace/{workspaceId}/sample-content.

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.

Completes the workspace's CloudStudio Intake Form, replacing any existing one, and generates a campaign brief from it. The workspace must be activated. Supply brandInfo.brandWebsite to have empty brand details filled from the website (request values always win), or brandName, industry, location, audience, brandVoices and campaignFocusAreas. The request is validated and accepted with 202; the brief is generated asynchronously and announced by the CAMPAIGN_BRIEF_GENERATED webhook, correlated by workspaceId. With autoApproveBrief: true the brief is approved once it is ready; for a first campaign that starts billing and generates content, announced by CONTENT_READY_FOR_REVIEW, and an optional startDate schedules it. Submissions for one workspace are not serialized: submit once and wait for CAMPAIGN_BRIEF_GENERATED before submitting again.

Retrieves the workspace's CloudStudio sample content batch. status is GENERATING while CloudStudio generates the draft content and while it creates the content library items from those drafts, PENDING_REVIEW while the batch is held for internal review before those items are created, which a sample batch never is, COMPLETED once the batch is finalized with at least one content library item, and FAILED otherwise; the CONTENT_GENERATION_FAILED webhook carries the reason. Once COMPLETED, provisionalContent lists the batch's provisional content items as CloudStudio generated them: changes to the content library items created from them are not reflected, and one whose content library item is deleted is still listed. Use each libraryContentId with the Get Content endpoint to query that content library item's current state; libraryStatus is ADDED while that item exists and DELETED once it has been deleted. A batch finalized before CloudStudio began keeping its provisional content items has an empty provisionalContent array. approvalUrl and externalUserApprovalUrl open the batch's content approval; they are null when the batch has no recorded approval, its approval has been deleted, or the agency or its white-label configuration cannot be loaded. Every field is present, null when it has no value. A workspace answers 404 until its sample run starts generating content.

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

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

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

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

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

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

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.

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.

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

Superseded by the List Configuration Defaults endpoint.

Superseded by the Retrieve Configuration Values endpoint.

Superseded by the Override Configuration endpoint.

Superseded by the Remove Configuration Override endpoint.