Workspaces

Update workspace settings

patch/workspaces/{id}/settings

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/workspaces/{id}/settings
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

idstring required

Workspace ID

Request body

$schemastring uri

A URL to the JSON Schema for this object.

avatar_urlstring
colorstring

Workspace accent color as a six-digit hex value

media_cleanup_daysinteger

Deprecated and ignored. Temporary media always becomes eligible after 14 unused days.

namestring

Workspace name

random_delay_minutesinteger
slot_end_hourinteger
slot_interval_minutesinteger
slot_start_hourinteger
timezonestring
week_startinteger

Example request

{
  "$schema": "https://example.com/api/v1/schemas/UpdateWorkspaceSettingsInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

avatar_urlstring required
colorstring required
media_cleanup_days14 required

Deprecated compatibility value. Always 14; temporary-media cleanup cannot be configured.

namestring required
random_delay_minutesinteger required
slot_end_hourinteger required
slot_interval_minutesinteger required
slot_start_hourinteger required
timezonestring required
week_startinteger required

Example response

{
  "$schema": "https://example.com/api/v1/schemas/UpdateWorkspaceSettingsOutputBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.