Platform API reference

Platform API · Workspace-Services

patch/v1/workspaces/{workspace_slug}/services/{service}/settingsAuth

Replace the settings jsonb for an active service

Path parameters

workspace_slug*string

Slug of the workspace. Platform routes name the workspace by slug, positionally in the SDK (`platform.workspaces.retrieve("acme")`); the product APIs bind `workspace_id` instead.

service*string

The product: `auth`, `mail`, `waitlist`, `social`, `trawl`, `flags` or `notify`.

Request body

object

Response · 200

workspace_id*string · uuid

Id of the workspace.

service*string

Service identifier (e.g. `mail`, `waitlist`, `social`, `auth`, `trawl`, `flags`, `notify`).

Example: "mail"

enabled*boolean

Whether the service is on for the workspace.

enabled_at*string · date-time

When the service was last turned on, or `null` if never.

enabled_by*string · uuid

Account id of who last turned it on, or `null`.

disabled_at*string · date-time

When the service was last turned off, or `null`.

disabled_by*string · uuid

Account id of who last turned it off, or `null`.

settings*object

Per-service settings blob (service-specific shape).

prelaunch*boolean

Whether the product is in preview (pre-launch): it is not turned on for new workspaces automatically, and the console badges it "Preview".

Example: false

Example

Request

PATCH https://api.platform-auth.productcraft.co/v1/workspaces/{workspace_slug}/services/{service}/settings
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "default_sender": "noreply@acme.com"
}

Response

{
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "service": "mail",
  "enabled": false,
  "enabled_at": "2026-01-01T00:00:00.000Z",
  "enabled_by": "00000000-0000-0000-0000-000000000000",
  "disabled_at": "2026-01-01T00:00:00.000Z",
  "disabled_by": "00000000-0000-0000-0000-000000000000",
  "settings": {},
  "prelaunch": false
}