antworkDOCS

Updating a workspace

Change a workspace's name, website, logo or settings. Only the fields you send change.

PATCHhttps://antwork.io/api/v1/workspaces/{id}Scopewrite

Request

curl -X PATCH https://antwork.io/api/v1/workspaces/ws_... \
  -H "Authorization: Bearer $ANTWORK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Studio",
    "logoUrl": "",
    "timezone": "Europe/Madrid",
    "preferredTimes": [
      "09:00",
      "18:00"
    ]
  }'

Send any of name (1 to 60 characters), website and logoUrl. Both URLs must be https://; a bare host gets https:// added, and "" or null clears the field. Settings: timezone (an IANA name such as Europe/Madrid, "" clears it), preferredTimes (a list of HH:MM times) and tagOutboundLinks (true adds UTM tags to links to the workspace's own website when a post publishes). Any other field is refused with invalid_body. Every change raises brandVersion. Needs the write scope.

Response

200 OK
{
  "object": "workspace",
  "id": "ws_...",
  "name": "Acme Studio",
  "website": "https://acme.com/",
  "logoUrl": null,
  "timezone": "Europe/Madrid",
  "preferredTimes": ["09:00", "18:00"],
  "tagOutboundLinks": false,
  "brandVersion": 5,
  "createdAt": "2026-01-05T09:00:00.000Z",
  "updatedAt": "2026-10-22T10:00:00.000Z"
}
There is no API call that deletes a workspace: it cancels every post scheduled in it, so it stays a deliberate step in the web app. A workspace that is not yours answers 404.

Something look wrong? Tell us which.