---
title: "Update workspace defaults"
method: PATCH
path: "/settings"
tags: ["Team & settings"]
---

# Update workspace defaults

`PATCH /settings`

## Request

- Base URL: `https://gtmswag.com/api/v1`
- URL: `https://gtmswag.com/api/v1/settings`
- Auth: HTTP bearer

Updates only the supplied fields. Owner or admin keys may call it (others get 403 TEAM_MANAGER_REQUIRED). Does not change account identity, payment or team membership.

## Request body

- object
  - `company` string: Default workspace sender company.
  - `name` string: Default workspace sender name.
  - `meetingUrl` union: An absolute URL, or an empty string for none. Both variants are strings, so the union has no discriminator.
    - ''
    - string, uri
  - `website` union: An absolute URL, or an empty string for none. Both variants are strings, so the union has no discriminator.
    - ''
    - string, uri
  - `brandColor` string: Six-digit hex brand color, e.g. #2454FF.
  - `webhookUrl` union: An absolute URL, or an empty string for none. Both variants are strings, so the union has no discriminator.
    - ''
    - string, uri

## Response `200`

Success: `{"data": WorkspaceSettings}`.

- WorkspaceSettingsResponse: The success body: `{"data": WorkspaceSettings}`.
  - `data` WorkspaceSettings, required: The defaults new campaigns use.
    - `company` string, required
    - `name` string, required
    - `meetingUrl` string, required
    - `website` string, required
    - `brandColor` string, required
    - `webhookUrl` string, required

## Other responses

- `400`: Bad request: `VALIDATION_ERROR`, `INVALID_JSON`. Each example says when.
- `401`: Not authenticated: `AUTH_REQUIRED`. no credentials, or an OAuth token on a route that only takes workspace keys; the key is malformed, unknown or revoked.
- `403`: Forbidden: `TEAM_MANAGER_REQUIRED`. Each example says when.
- `413`: Request too large: `INVALID_REQUEST`. the body exceeds 1 MiB.
- `415`: Unsupported media type: `INVALID_REQUEST`. a write with a body that is not `Content-Type: application/json` (a key request with no body needs no Content-Type).
- `429`: Too many requests: `RATE_LIMIT`. more than 240 requests in the current minute for this workspace (REST and MCP share the limit); wait `retryAfterMs`.
- `default`: Any other refusal or failure, such as 403 CSRF (a cross-origin `Origin` header), 403 HTTPS_REQUIRED or 500 INTERNAL_ERROR, with what to do next.

---

[API](https://skmtc.dev/gtmswag/apis/gtm-swag-api.md) · [All operations](https://skmtc.dev/gtmswag/apis/gtm-swag-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gtmswag/apis/gtm-swag-api/revisions/9ff86fa99afe?raw)