COcontentstudio
🏢 Workspaces

Create a workspace

Changed on

Creates a new workspace owned by the authenticated user. Subject to the plan's workspace limit. * * timezone accepts any IANA identifier plus the legacy aliases the product accepts (US/Pacific, US/Eastern, America/Buenos_Aires, MST7MDT, …); an alias is stored in canonical form and the canonical value is returned. An unrecognised identifier is rejected with 422.

post/api/v1/workspaces

Request

  • Base URL
    https://api.contentstudio.io
  • URL
    https://api.contentstudio.io/api/v1/workspaces
  • Auth
    API key in header X-API-Key

Request body

namestring required
logostring url required
timezonestring required
super_admin_idstring nullable

Account owner to create the workspace under. Optional when you are the account owner or are linked to exactly one super admin; required when you manage multiple super admins.

notestring nullable
instagram_posting_method'api' | 'mobile'
company_namestring nullable

Report branding name, shown on generated reports and white-labelled dashboards.

company_logostring url nullable

Report branding logo. Upload bytes via POST /workspaces/{workspace_id}/media and pass the returned URL.

Example request

{
  "name": "Acme Marketing",
  "logo": "https://logo.clearbit.com/contentstudio.io",
  "timezone": "Asia/Karachi",
  "super_admin_id": "610a1d92b11ba161ce1cd372",
  "note": "Client workspace",
  "instagram_posting_method": "api",
  "first_day": {
    "day": "Monday",
    "key": 1
  },
  "company_name": "Acme Inc",
  "company_logo": "https://storage.googleapis.com/lumotive-web-storage/analytics/companies/610a1d92b11ba161ce1cd372/company.jpg"
}

Response

Workspace created successfully

statusboolean
messagestring
dataobject

Example response

{
  "status": true,
  "message": "Workspace created successfully. Use the returned `id` as `workspace_id` in subsequent requests."
}

Changes

  • 2ce09d50369cRevision changes
    • breaking

      added subschema #4 to the response body oneOf list for the response status

  • ad0b687289a3Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status