> For the complete documentation index, see [llms.txt](https://developers.gleantap.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.gleantap.com/api-reference-v3/workroom-settings.md).

# Workroom Settings

Workroom configuration: general info, email defaults, SMS templates and compliance text, phone numbers, and sender email addresses. Requires the `workrooms:configure` scope. Unknown fields in `PATCH` requests are ignored. Provider credentials stay in the dashboard and aren't exposed here.

## GET /workrooms/{id}/settings

> Retrieve general workroom settings.

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"WorkroomSettings":{"type":"object","description":"General workroom settings — the \"Workroom\" tab in the dashboard.","properties":{"id":{"$ref":"#/components/schemas/WorkroomId"},"object":{"type":"string","enum":["workroom_settings"]},"app_name":{"type":"string","nullable":true,"description":"Display name for the workroom."},"company_name":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true,"description":"IANA timezone (e.g. `America/Chicago`)."},"address1":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"app_colour":{"type":"string","nullable":true,"description":"Primary brand color (hex `#rrggbb`)."},"social_links":{"$ref":"#/components/schemas/SocialLinks"}}},"WorkroomId":{"type":"string","pattern":"^wrm_[0-9a-f]{24}$"},"SocialLinks":{"type":"object","properties":{"facebook":{"type":"string","nullable":true},"instagram":{"type":"string","nullable":true},"linkedin":{"type":"string","nullable":true},"twitter":{"type":"string","nullable":true},"youtube":{"type":"string","nullable":true},"tiktok":{"type":"string","nullable":true}}},"Problem":{"type":"object","description":"RFC 9457 Problem Details with Gleantap extensions. Every error response follows this shape.\nHandle by inspecting the `code` field (not the human-readable `title` or `detail`), which is stable across versions.\n","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the human-readable error documentation."},"title":{"type":"string","description":"Short human-readable summary."},"status":{"type":"integer","description":"HTTP status code repeated in the body for convenience."},"detail":{"type":"string","description":"Longer human-readable explanation. May be null.","nullable":true},"code":{"type":"string","description":"Machine-readable error code. This is the field to switch on programmatically.\nStandard values include: `authentication_required`, `invalid_credentials`, `permission_denied`, `scope_required`, `resource_not_found`, `validation_error`, `invalid_field`, `missing_field`, `idempotency_conflict`, `rate_limited`, `quota_exceeded`, `internal_error`, `service_unavailable`, `feature_not_enabled`, `compliance_block`, `version_conflict`.\n"},"request_id":{"type":"string","description":"The X-Request-ID for this response. Include when reporting issues."},"errors":{"type":"array","nullable":true,"description":"Field-level details, present on validation errors.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}}}}},"responses":{"NotFound":{"description":"The resource doesn't exist or isn't visible to this caller.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"paths":{"/workrooms/{id}/settings":{"get":{"tags":["Workroom Settings"],"operationId":"retrieveWorkroomSettings","summary":"Retrieve general workroom settings.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomSettings"}}}},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```

## PATCH /workrooms/{id}/settings

> Update general workroom settings (name, timezone, address, branding, social links).

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"WorkroomSettingsUpdate":{"type":"object","description":"Partial update. All fields optional; unknown fields are silently ignored.","properties":{"app_name":{"type":"string"},"company_name":{"type":"string"},"website":{"type":"string"},"timezone":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"app_colour":{"type":"string"},"facebook_link":{"type":"string"},"instagram_link":{"type":"string"},"linkedin":{"type":"string"},"twitter":{"type":"string"},"youtube":{"type":"string"},"tiktok":{"type":"string"}}},"WorkroomSettings":{"type":"object","description":"General workroom settings — the \"Workroom\" tab in the dashboard.","properties":{"id":{"$ref":"#/components/schemas/WorkroomId"},"object":{"type":"string","enum":["workroom_settings"]},"app_name":{"type":"string","nullable":true,"description":"Display name for the workroom."},"company_name":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true,"description":"IANA timezone (e.g. `America/Chicago`)."},"address1":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"app_colour":{"type":"string","nullable":true,"description":"Primary brand color (hex `#rrggbb`)."},"social_links":{"$ref":"#/components/schemas/SocialLinks"}}},"WorkroomId":{"type":"string","pattern":"^wrm_[0-9a-f]{24}$"},"SocialLinks":{"type":"object","properties":{"facebook":{"type":"string","nullable":true},"instagram":{"type":"string","nullable":true},"linkedin":{"type":"string","nullable":true},"twitter":{"type":"string","nullable":true},"youtube":{"type":"string","nullable":true},"tiktok":{"type":"string","nullable":true}}}}},"paths":{"/workrooms/{id}/settings":{"patch":{"tags":["Workroom Settings"],"operationId":"updateWorkroomSettings","summary":"Update general workroom settings (name, timezone, address, branding, social links).","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomSettingsUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomSettings"}}}}}}}}}
```

## Retrieve a workroom's email settings.

> Sending identity and email configuration for the workroom — from-address, reply-to and the configured gateway.<br>

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"WorkroomEmailSettings":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/WorkroomId"},"object":{"type":"string","enum":["workroom_email_settings"]},"from_email":{"type":"string","nullable":true,"description":"Default from-address on outbound emails."},"from_name":{"type":"string","nullable":true},"from_sender_name":{"type":"string","nullable":true,"description":"Display name shown in the recipient inbox."},"default_email":{"type":"string","nullable":true,"description":"Same as from_email in most workrooms."},"reply_to_email":{"type":"string","nullable":true},"domain":{"type":"string","nullable":true,"description":"Workroom email domain. Must be present in the account's verified custom_domains list."},"email_quiet_hours":{"$ref":"#/components/schemas/QuietHours"},"email_unsubscribe_footer":{"type":"string","nullable":true},"email_address_footer":{"type":"string","nullable":true,"description":"Physical mailing address footer required by anti-spam laws."},"forward_email_copy":{"type":"string","nullable":true},"forward_inbox_email_copy":{"type":"string","nullable":true},"cc_inbox_email_to":{"type":"string","nullable":true,"description":"Comma-separated list of internal CC recipients on inbound email replies."}}},"WorkroomId":{"type":"string","pattern":"^wrm_[0-9a-f]{24}$"},"QuietHours":{"type":"object","properties":{"min":{"type":"string","nullable":true,"description":"Lower bound, e.g. \"07:00 pm\"."},"max":{"type":"string","nullable":true,"description":"Upper bound, e.g. \"07:30 pm\"."}}}}},"paths":{"/workrooms/{id}/settings/email":{"get":{"tags":["Workroom Settings"],"operationId":"retrieveWorkroomEmailSettings","summary":"Retrieve a workroom's email settings.","description":"Sending identity and email configuration for the workroom — from-address, reply-to and the configured gateway.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomEmailSettings"}}}}}}}}}
```

## PATCH /workrooms/{id}/settings/email

> Update the workroom's email defaults. Domain must be verified.

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"WorkroomEmailSettingsUpdate":{"type":"object","description":"Partial update. `from_email` / `domain` changes REQUIRE the requested domain to be verified in the account's `custom_domains` list — 422 `validation_failed` otherwise. Domains not in `custom_domains` (Gleantap-managed defaults like `cx1.gleantap.org`) are accepted.","properties":{"from_email":{"type":"string"},"from_name":{"type":"string"},"from_sender_name":{"type":"string"},"default_email":{"type":"string"},"reply_to_email":{"type":"string"},"domain":{"type":"string"},"email_quiet_hours":{"$ref":"#/components/schemas/QuietHours"},"email_unsubscribe_footer":{"type":"string"},"email_address_footer":{"type":"string"},"forward_email_copy":{"type":"string"},"forward_inbox_email_copy":{"type":"string"},"cc_inbox_email_to":{"type":"string"}}},"QuietHours":{"type":"object","properties":{"min":{"type":"string","nullable":true,"description":"Lower bound, e.g. \"07:00 pm\"."},"max":{"type":"string","nullable":true,"description":"Upper bound, e.g. \"07:30 pm\"."}}},"WorkroomEmailSettings":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/WorkroomId"},"object":{"type":"string","enum":["workroom_email_settings"]},"from_email":{"type":"string","nullable":true,"description":"Default from-address on outbound emails."},"from_name":{"type":"string","nullable":true},"from_sender_name":{"type":"string","nullable":true,"description":"Display name shown in the recipient inbox."},"default_email":{"type":"string","nullable":true,"description":"Same as from_email in most workrooms."},"reply_to_email":{"type":"string","nullable":true},"domain":{"type":"string","nullable":true,"description":"Workroom email domain. Must be present in the account's verified custom_domains list."},"email_quiet_hours":{"$ref":"#/components/schemas/QuietHours"},"email_unsubscribe_footer":{"type":"string","nullable":true},"email_address_footer":{"type":"string","nullable":true,"description":"Physical mailing address footer required by anti-spam laws."},"forward_email_copy":{"type":"string","nullable":true},"forward_inbox_email_copy":{"type":"string","nullable":true},"cc_inbox_email_to":{"type":"string","nullable":true,"description":"Comma-separated list of internal CC recipients on inbound email replies."}}},"WorkroomId":{"type":"string","pattern":"^wrm_[0-9a-f]{24}$"},"Problem":{"type":"object","description":"RFC 9457 Problem Details with Gleantap extensions. Every error response follows this shape.\nHandle by inspecting the `code` field (not the human-readable `title` or `detail`), which is stable across versions.\n","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the human-readable error documentation."},"title":{"type":"string","description":"Short human-readable summary."},"status":{"type":"integer","description":"HTTP status code repeated in the body for convenience."},"detail":{"type":"string","description":"Longer human-readable explanation. May be null.","nullable":true},"code":{"type":"string","description":"Machine-readable error code. This is the field to switch on programmatically.\nStandard values include: `authentication_required`, `invalid_credentials`, `permission_denied`, `scope_required`, `resource_not_found`, `validation_error`, `invalid_field`, `missing_field`, `idempotency_conflict`, `rate_limited`, `quota_exceeded`, `internal_error`, `service_unavailable`, `feature_not_enabled`, `compliance_block`, `version_conflict`.\n"},"request_id":{"type":"string","description":"The X-Request-ID for this response. Include when reporting issues."},"errors":{"type":"array","nullable":true,"description":"Field-level details, present on validation errors.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}},"paths":{"/workrooms/{id}/settings/email":{"patch":{"tags":["Workroom Settings"],"operationId":"updateWorkroomEmailSettings","summary":"Update the workroom's email defaults. Domain must be verified.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomEmailSettingsUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomEmailSettings"}}}},"422":{"description":"Validation failed (unverified domain, etc.).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}}}}
```

## Retrieve a workroom's SMS settings.

> SMS configuration for the workroom, including its default sending number and provider.<br>

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"WorkroomSmsSettings":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/WorkroomId"},"object":{"type":"string","enum":["workroom_sms_settings"]},"default_sms_number":{"type":"string","nullable":true},"default_sms_number_type":{"type":"string","nullable":true,"enum":["twilio","telnyx","edgility","ringcentral",null]},"from_sender_name":{"type":"string","nullable":true},"optin_message":{"type":"string","nullable":true},"doubleoptin_message":{"type":"string","nullable":true},"optout_message":{"type":"string","nullable":true},"help_message":{"type":"string","nullable":true},"thankyou_optin_message":{"type":"string","nullable":true},"optin_keywords":{"type":"array","items":{"type":"string"},"description":"Uppercase."},"optout_keywords":{"type":"array","items":{"type":"string"},"description":"Uppercase."},"sms_quiet_hours":{"$ref":"#/components/schemas/QuietHours"},"max_sms_per_day":{"type":"string","nullable":true},"max_sms_per_week":{"type":"string","nullable":true},"auto_response":{"type":"string","nullable":true},"auto_response_quiethoursms":{"type":"string","nullable":true},"auto_response_optoutinstructionsms":{"type":"string","nullable":true},"auto_response_optoutinstructionsms_status":{"type":"boolean"},"widget_message":{"type":"string","nullable":true},"widget_optin_disclaimer":{"type":"string","nullable":true},"optin_settings":{"type":"object","properties":{"contact_texts_in":{"type":"string","nullable":true},"contact_website":{"type":"string","nullable":true},"new_via_integration":{"type":"string","nullable":true},"allow_sending_to":{"type":"string","nullable":true},"other_contacts":{"type":"string","nullable":true}}}}},"WorkroomId":{"type":"string","pattern":"^wrm_[0-9a-f]{24}$"},"QuietHours":{"type":"object","properties":{"min":{"type":"string","nullable":true,"description":"Lower bound, e.g. \"07:00 pm\"."},"max":{"type":"string","nullable":true,"description":"Upper bound, e.g. \"07:30 pm\"."}}}}},"paths":{"/workrooms/{id}/settings/sms":{"get":{"tags":["Workroom Settings"],"operationId":"retrieveWorkroomSmsSettings","summary":"Retrieve a workroom's SMS settings.","description":"SMS configuration for the workroom, including its default sending number and provider.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomSmsSettings"}}}}}}}}}
```

## PATCH /workrooms/{id}/settings/sms

> Update the workroom's SMS templates, compliance text, quiet hours, and default number.

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"WorkroomSmsSettingsUpdate":{"type":"object","description":"Partial update. `default_sms_number` must be a registered number in this workroom (see `/workrooms/{id}/phone_numbers`) — 422 `validation_failed` otherwise. `optin_keywords` and `optout_keywords` are auto-uppercased. The opt-in/opt-out/help/thank-you messages and the `auto_response*` texts are sent as SMS: At most 10 SMS segments: 1530 plain (GSM-7) characters, or 670 if the text contains emoji or any other non-GSM character (once split, each segment holds 153 GSM / 67 unicode characters; emoji count as 2). Merge tags count as written, not expanded. Longer texts are rejected with 400 `sms_too_long`.","properties":{"default_sms_number":{"type":"string"},"default_sms_number_type":{"type":"string","enum":["twilio","telnyx","edgility","ringcentral"]},"from_sender_name":{"type":"string"},"doubleoptinmessage":{"type":"string"},"optinmessage":{"type":"string"},"optoutmessage":{"type":"string"},"helpmessage":{"type":"string"},"thankyouoptin":{"type":"string"},"optinkeywords":{"type":"array","items":{"type":"string"}},"optoutkeywords":{"type":"array","items":{"type":"string"}},"sms_quiet_hours":{"$ref":"#/components/schemas/QuietHours"},"max_sms":{"type":"object","properties":{"per_day":{"type":"string"},"per_week":{"type":"string"}}},"auto_response":{"type":"string"},"auto_response_quiethoursms":{"type":"string"},"auto_response_optoutinstructionsms":{"type":"string"},"auto_response_optoutinstructionsms_status":{"type":"boolean"},"widget_message":{"type":"string"},"widget_optin_disclaimer":{"type":"string"},"optin_settings":{"type":"object","additionalProperties":{"type":"string"}}}},"QuietHours":{"type":"object","properties":{"min":{"type":"string","nullable":true,"description":"Lower bound, e.g. \"07:00 pm\"."},"max":{"type":"string","nullable":true,"description":"Upper bound, e.g. \"07:30 pm\"."}}},"WorkroomSmsSettings":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/WorkroomId"},"object":{"type":"string","enum":["workroom_sms_settings"]},"default_sms_number":{"type":"string","nullable":true},"default_sms_number_type":{"type":"string","nullable":true,"enum":["twilio","telnyx","edgility","ringcentral",null]},"from_sender_name":{"type":"string","nullable":true},"optin_message":{"type":"string","nullable":true},"doubleoptin_message":{"type":"string","nullable":true},"optout_message":{"type":"string","nullable":true},"help_message":{"type":"string","nullable":true},"thankyou_optin_message":{"type":"string","nullable":true},"optin_keywords":{"type":"array","items":{"type":"string"},"description":"Uppercase."},"optout_keywords":{"type":"array","items":{"type":"string"},"description":"Uppercase."},"sms_quiet_hours":{"$ref":"#/components/schemas/QuietHours"},"max_sms_per_day":{"type":"string","nullable":true},"max_sms_per_week":{"type":"string","nullable":true},"auto_response":{"type":"string","nullable":true},"auto_response_quiethoursms":{"type":"string","nullable":true},"auto_response_optoutinstructionsms":{"type":"string","nullable":true},"auto_response_optoutinstructionsms_status":{"type":"boolean"},"widget_message":{"type":"string","nullable":true},"widget_optin_disclaimer":{"type":"string","nullable":true},"optin_settings":{"type":"object","properties":{"contact_texts_in":{"type":"string","nullable":true},"contact_website":{"type":"string","nullable":true},"new_via_integration":{"type":"string","nullable":true},"allow_sending_to":{"type":"string","nullable":true},"other_contacts":{"type":"string","nullable":true}}}}},"WorkroomId":{"type":"string","pattern":"^wrm_[0-9a-f]{24}$"},"Problem":{"type":"object","description":"RFC 9457 Problem Details with Gleantap extensions. Every error response follows this shape.\nHandle by inspecting the `code` field (not the human-readable `title` or `detail`), which is stable across versions.\n","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the human-readable error documentation."},"title":{"type":"string","description":"Short human-readable summary."},"status":{"type":"integer","description":"HTTP status code repeated in the body for convenience."},"detail":{"type":"string","description":"Longer human-readable explanation. May be null.","nullable":true},"code":{"type":"string","description":"Machine-readable error code. This is the field to switch on programmatically.\nStandard values include: `authentication_required`, `invalid_credentials`, `permission_denied`, `scope_required`, `resource_not_found`, `validation_error`, `invalid_field`, `missing_field`, `idempotency_conflict`, `rate_limited`, `quota_exceeded`, `internal_error`, `service_unavailable`, `feature_not_enabled`, `compliance_block`, `version_conflict`.\n"},"request_id":{"type":"string","description":"The X-Request-ID for this response. Include when reporting issues."},"errors":{"type":"array","nullable":true,"description":"Field-level details, present on validation errors.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}},"paths":{"/workrooms/{id}/settings/sms":{"patch":{"tags":["Workroom Settings"],"operationId":"updateWorkroomSmsSettings","summary":"Update the workroom's SMS templates, compliance text, quiet hours, and default number.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomSmsSettingsUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomSmsSettings"}}}},"422":{"description":"Validation failed (unknown default_sms_number, etc.).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}}}}
```

## List phone numbers configured for a workroom.

> Numbers are pre-provisioned via the dashboard (through Twilio, Telnyx, etc.) — this endpoint is read-only for the number list. Use PATCH \`/workrooms/{id}/phone\_numbers/{number\_id}\` to set the default and toggle SMS/voice.

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"ListEnvelope":{"type":"object","required":["object","data","has_more","next_cursor","prev_cursor"],"properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"type":"object"},"description":"The page of results. Item type varies per endpoint — see the specific response schema."},"has_more":{"type":"boolean","description":"True if additional records exist beyond this page."},"next_cursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page. Null on the last page."},"prev_cursor":{"type":"string","nullable":true,"description":"Cursor for the previous page. Supported on `listContacts` and `listSegmentContacts`: pass it back as `?before=...` to page backward; `null` on the first page. On every other list endpoint paging is forward-only and this is always `null`."}}},"WorkroomPhoneNumber":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PhoneNumberId"},"object":{"type":"string","enum":["phone_number"]},"phone_number":{"type":"string","nullable":true},"type":{"type":"string","nullable":true,"enum":["twilio","telnyx","edgility","ringcentral",null],"description":"The upstream provider."},"number_type":{"type":"string","nullable":true,"description":"e.g. `tollfree`, `local`, `dlc`."},"status":{"type":"string","nullable":true,"description":"Provider verification status (VERIFIED, PENDING, REJECTED, etc.). Read-only; managed by the dashboard verification flow."},"is_default_number":{"type":"boolean"},"is_sms_enabled":{"type":"boolean"},"is_voice_enabled":{"type":"boolean"},"assigned_to":{"type":"string","nullable":true,"description":"`All` or a specific staff id."},"assigned_to_person":{"type":"array","items":{"$ref":"#/components/schemas/StaffId"}},"call_forwarding":{"type":"object","properties":{"status":{"type":"boolean"},"type":{"type":"string","nullable":true},"phone_number":{"type":"string","nullable":true}}},"voicemail":{"type":"object","properties":{"status":{"type":"boolean"},"text":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"caller_status":{"type":"boolean"},"caller_email":{"type":"string","nullable":true},"caller_text":{"type":"string","nullable":true},"caller_type":{"type":"string","nullable":true}}},"call_quiet_hours":{"type":"object","properties":{"status":{"type":"boolean"},"from_hours":{"type":"string","nullable":true},"to_hours":{"type":"string","nullable":true},"voicemail_text":{"type":"string","nullable":true},"voicemail_type":{"type":"string","nullable":true}}},"sms_quiet_hours":{"$ref":"#/components/schemas/QuietHours"},"sms_quiet_hours_status":{"type":"boolean"},"call_recording_notify":{"type":"object","properties":{"status":{"type":"boolean"},"text":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"created_at":{"$ref":"#/components/schemas/Timestamp"},"updated_at":{"$ref":"#/components/schemas/Timestamp"}}},"PhoneNumberId":{"type":"string","pattern":"^pn_[0-9a-f]{24}$","description":"A phone number configured for a workroom (Twilio/Telnyx/etc.) — used as the SMS/voice sender."},"StaffId":{"type":"string","pattern":"^usr_[0-9a-f]{24}$","description":"A staff user (from the legacy `users` collection). Used for `owner_id`, `responsible_id`, `created_by`, `assigned_to`, etc."},"QuietHours":{"type":"object","properties":{"min":{"type":"string","nullable":true,"description":"Lower bound, e.g. \"07:00 pm\"."},"max":{"type":"string","nullable":true,"description":"Upper bound, e.g. \"07:30 pm\"."}}},"Timestamp":{"type":"string","format":"date-time","description":"RFC 3339 timestamp, always UTC, millisecond precision."}}},"paths":{"/workrooms/{id}/phone_numbers":{"get":{"tags":["Workroom Settings"],"operationId":"listWorkroomPhoneNumbers","summary":"List phone numbers configured for a workroom.","description":"Numbers are pre-provisioned via the dashboard (through Twilio, Telnyx, etc.) — this endpoint is read-only for the number list. Use PATCH `/workrooms/{id}/phone_numbers/{number_id}` to set the default and toggle SMS/voice.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ListEnvelope"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkroomPhoneNumber"}}}}]}}}}}}}}}
```

## Retrieve one workroom phone number.

> A single provisioned number, its capabilities and whether it is the workroom's default for SMS.<br>

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"WorkroomPhoneNumber":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PhoneNumberId"},"object":{"type":"string","enum":["phone_number"]},"phone_number":{"type":"string","nullable":true},"type":{"type":"string","nullable":true,"enum":["twilio","telnyx","edgility","ringcentral",null],"description":"The upstream provider."},"number_type":{"type":"string","nullable":true,"description":"e.g. `tollfree`, `local`, `dlc`."},"status":{"type":"string","nullable":true,"description":"Provider verification status (VERIFIED, PENDING, REJECTED, etc.). Read-only; managed by the dashboard verification flow."},"is_default_number":{"type":"boolean"},"is_sms_enabled":{"type":"boolean"},"is_voice_enabled":{"type":"boolean"},"assigned_to":{"type":"string","nullable":true,"description":"`All` or a specific staff id."},"assigned_to_person":{"type":"array","items":{"$ref":"#/components/schemas/StaffId"}},"call_forwarding":{"type":"object","properties":{"status":{"type":"boolean"},"type":{"type":"string","nullable":true},"phone_number":{"type":"string","nullable":true}}},"voicemail":{"type":"object","properties":{"status":{"type":"boolean"},"text":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"caller_status":{"type":"boolean"},"caller_email":{"type":"string","nullable":true},"caller_text":{"type":"string","nullable":true},"caller_type":{"type":"string","nullable":true}}},"call_quiet_hours":{"type":"object","properties":{"status":{"type":"boolean"},"from_hours":{"type":"string","nullable":true},"to_hours":{"type":"string","nullable":true},"voicemail_text":{"type":"string","nullable":true},"voicemail_type":{"type":"string","nullable":true}}},"sms_quiet_hours":{"$ref":"#/components/schemas/QuietHours"},"sms_quiet_hours_status":{"type":"boolean"},"call_recording_notify":{"type":"object","properties":{"status":{"type":"boolean"},"text":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"created_at":{"$ref":"#/components/schemas/Timestamp"},"updated_at":{"$ref":"#/components/schemas/Timestamp"}}},"PhoneNumberId":{"type":"string","pattern":"^pn_[0-9a-f]{24}$","description":"A phone number configured for a workroom (Twilio/Telnyx/etc.) — used as the SMS/voice sender."},"StaffId":{"type":"string","pattern":"^usr_[0-9a-f]{24}$","description":"A staff user (from the legacy `users` collection). Used for `owner_id`, `responsible_id`, `created_by`, `assigned_to`, etc."},"QuietHours":{"type":"object","properties":{"min":{"type":"string","nullable":true,"description":"Lower bound, e.g. \"07:00 pm\"."},"max":{"type":"string","nullable":true,"description":"Upper bound, e.g. \"07:30 pm\"."}}},"Timestamp":{"type":"string","format":"date-time","description":"RFC 3339 timestamp, always UTC, millisecond precision."},"Problem":{"type":"object","description":"RFC 9457 Problem Details with Gleantap extensions. Every error response follows this shape.\nHandle by inspecting the `code` field (not the human-readable `title` or `detail`), which is stable across versions.\n","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the human-readable error documentation."},"title":{"type":"string","description":"Short human-readable summary."},"status":{"type":"integer","description":"HTTP status code repeated in the body for convenience."},"detail":{"type":"string","description":"Longer human-readable explanation. May be null.","nullable":true},"code":{"type":"string","description":"Machine-readable error code. This is the field to switch on programmatically.\nStandard values include: `authentication_required`, `invalid_credentials`, `permission_denied`, `scope_required`, `resource_not_found`, `validation_error`, `invalid_field`, `missing_field`, `idempotency_conflict`, `rate_limited`, `quota_exceeded`, `internal_error`, `service_unavailable`, `feature_not_enabled`, `compliance_block`, `version_conflict`.\n"},"request_id":{"type":"string","description":"The X-Request-ID for this response. Include when reporting issues."},"errors":{"type":"array","nullable":true,"description":"Field-level details, present on validation errors.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}}}}},"responses":{"NotFound":{"description":"The resource doesn't exist or isn't visible to this caller.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"paths":{"/workrooms/{id}/phone_numbers/{number_id}":{"get":{"tags":["Workroom Settings"],"operationId":"retrieveWorkroomPhoneNumber","summary":"Retrieve one workroom phone number.","description":"A single provisioned number, its capabilities and whether it is the workroom's default for SMS.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomPhoneNumber"}}}},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```

## Update settable fields on a phone number (default, sms/voice toggles, assignments, voicemail, quiet hours, call forwarding).

> Setting \`is\_default\_number=true\` also mirrors to the workroom's \`default\_sms\_number\` + \`default\_sms\_number\_type\`.

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"WorkroomPhoneNumberUpdate":{"type":"object","description":"Partial update. Only these fields are settable via API — provider verification metadata (status, business info, etc.) stays UI-only. Setting `is_default_number=true` also updates the workroom's `default_sms_number` + `default_sms_number_type`.","properties":{"is_default_number":{"type":"boolean"},"is_sms_enabled":{"type":"boolean"},"is_voice_enabled":{"type":"boolean"},"assigned_to":{"type":"string"},"assigned_to_person":{"type":"array","items":{"$ref":"#/components/schemas/StaffId"}},"call_forwarding_status":{"type":"boolean"},"call_forwarding_type":{"type":"string"},"call_forwarding_phonenumber":{"type":"string"},"call_voicemail_status":{"type":"boolean"},"call_voicemail_text":{"type":"string"},"call_voicemail_type":{"type":"string"},"caller_voicemail_status":{"type":"boolean"},"caller_voicemail_email":{"type":"string"},"caller_voicemail_text":{"type":"string"},"caller_voicemail_type":{"type":"string"},"quiethour_status":{"type":"boolean"},"quiethour_from_hours":{"type":"string"},"quiethour_to_hours":{"type":"string"},"quiethour_voicemail_text":{"type":"string"},"quiethour_voicemail_type":{"type":"string"},"sms_quiethour_status":{"type":"boolean"},"sms_quiet_hours":{"$ref":"#/components/schemas/QuietHours"},"call_recording_notify_text":{"type":"string"},"call_recording_notify_type":{"type":"string"},"caller_recording_notify_status":{"type":"boolean"}}},"StaffId":{"type":"string","pattern":"^usr_[0-9a-f]{24}$","description":"A staff user (from the legacy `users` collection). Used for `owner_id`, `responsible_id`, `created_by`, `assigned_to`, etc."},"QuietHours":{"type":"object","properties":{"min":{"type":"string","nullable":true,"description":"Lower bound, e.g. \"07:00 pm\"."},"max":{"type":"string","nullable":true,"description":"Upper bound, e.g. \"07:30 pm\"."}}},"WorkroomPhoneNumber":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PhoneNumberId"},"object":{"type":"string","enum":["phone_number"]},"phone_number":{"type":"string","nullable":true},"type":{"type":"string","nullable":true,"enum":["twilio","telnyx","edgility","ringcentral",null],"description":"The upstream provider."},"number_type":{"type":"string","nullable":true,"description":"e.g. `tollfree`, `local`, `dlc`."},"status":{"type":"string","nullable":true,"description":"Provider verification status (VERIFIED, PENDING, REJECTED, etc.). Read-only; managed by the dashboard verification flow."},"is_default_number":{"type":"boolean"},"is_sms_enabled":{"type":"boolean"},"is_voice_enabled":{"type":"boolean"},"assigned_to":{"type":"string","nullable":true,"description":"`All` or a specific staff id."},"assigned_to_person":{"type":"array","items":{"$ref":"#/components/schemas/StaffId"}},"call_forwarding":{"type":"object","properties":{"status":{"type":"boolean"},"type":{"type":"string","nullable":true},"phone_number":{"type":"string","nullable":true}}},"voicemail":{"type":"object","properties":{"status":{"type":"boolean"},"text":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"caller_status":{"type":"boolean"},"caller_email":{"type":"string","nullable":true},"caller_text":{"type":"string","nullable":true},"caller_type":{"type":"string","nullable":true}}},"call_quiet_hours":{"type":"object","properties":{"status":{"type":"boolean"},"from_hours":{"type":"string","nullable":true},"to_hours":{"type":"string","nullable":true},"voicemail_text":{"type":"string","nullable":true},"voicemail_type":{"type":"string","nullable":true}}},"sms_quiet_hours":{"$ref":"#/components/schemas/QuietHours"},"sms_quiet_hours_status":{"type":"boolean"},"call_recording_notify":{"type":"object","properties":{"status":{"type":"boolean"},"text":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"created_at":{"$ref":"#/components/schemas/Timestamp"},"updated_at":{"$ref":"#/components/schemas/Timestamp"}}},"PhoneNumberId":{"type":"string","pattern":"^pn_[0-9a-f]{24}$","description":"A phone number configured for a workroom (Twilio/Telnyx/etc.) — used as the SMS/voice sender."},"Timestamp":{"type":"string","format":"date-time","description":"RFC 3339 timestamp, always UTC, millisecond precision."}}},"paths":{"/workrooms/{id}/phone_numbers/{number_id}":{"patch":{"tags":["Workroom Settings"],"operationId":"updateWorkroomPhoneNumber","summary":"Update settable fields on a phone number (default, sms/voice toggles, assignments, voicemail, quiet hours, call forwarding).","description":"Setting `is_default_number=true` also mirrors to the workroom's `default_sms_number` + `default_sms_number_type`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomPhoneNumberUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomPhoneNumber"}}}}}}}}}
```

## GET /workrooms/{id}/email\_addresses

> List the workroom's configured sender email addresses.

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"ListEnvelope":{"type":"object","required":["object","data","has_more","next_cursor","prev_cursor"],"properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"type":"object"},"description":"The page of results. Item type varies per endpoint — see the specific response schema."},"has_more":{"type":"boolean","description":"True if additional records exist beyond this page."},"next_cursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page. Null on the last page."},"prev_cursor":{"type":"string","nullable":true,"description":"Cursor for the previous page. Supported on `listContacts` and `listSegmentContacts`: pass it back as `?before=...` to page backward; `null` on the first page. On every other list endpoint paging is forward-only and this is always `null`."}}},"WorkroomEmailAddress":{"type":"object","description":"A sender address in the workroom's email_topics list. Set `is_default=true` (via PATCH) to make it the workroom's default sender — the write cascades to `default_email` + `reply_to_email` on the workroom.\n","properties":{"id":{"$ref":"#/components/schemas/EmailAddressId"},"object":{"type":"string","enum":["email_address"]},"user_name":{"type":"string","nullable":true},"user_email":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"is_default":{"type":"boolean"}}},"EmailAddressId":{"type":"string","pattern":"^ea_[0-9a-f]{24}$"}}},"paths":{"/workrooms/{id}/email_addresses":{"get":{"tags":["Workroom Settings"],"operationId":"listWorkroomEmailAddresses","summary":"List the workroom's configured sender email addresses.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ListEnvelope"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkroomEmailAddress"}}}}]}}}}}}}}}
```

## Retrieve one workroom sending address.

> A single configured from-address, with its verification state. An unverified address cannot be used to send.<br>

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"WorkroomEmailAddress":{"type":"object","description":"A sender address in the workroom's email_topics list. Set `is_default=true` (via PATCH) to make it the workroom's default sender — the write cascades to `default_email` + `reply_to_email` on the workroom.\n","properties":{"id":{"$ref":"#/components/schemas/EmailAddressId"},"object":{"type":"string","enum":["email_address"]},"user_name":{"type":"string","nullable":true},"user_email":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"is_default":{"type":"boolean"}}},"EmailAddressId":{"type":"string","pattern":"^ea_[0-9a-f]{24}$"},"Problem":{"type":"object","description":"RFC 9457 Problem Details with Gleantap extensions. Every error response follows this shape.\nHandle by inspecting the `code` field (not the human-readable `title` or `detail`), which is stable across versions.\n","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the human-readable error documentation."},"title":{"type":"string","description":"Short human-readable summary."},"status":{"type":"integer","description":"HTTP status code repeated in the body for convenience."},"detail":{"type":"string","description":"Longer human-readable explanation. May be null.","nullable":true},"code":{"type":"string","description":"Machine-readable error code. This is the field to switch on programmatically.\nStandard values include: `authentication_required`, `invalid_credentials`, `permission_denied`, `scope_required`, `resource_not_found`, `validation_error`, `invalid_field`, `missing_field`, `idempotency_conflict`, `rate_limited`, `quota_exceeded`, `internal_error`, `service_unavailable`, `feature_not_enabled`, `compliance_block`, `version_conflict`.\n"},"request_id":{"type":"string","description":"The X-Request-ID for this response. Include when reporting issues."},"errors":{"type":"array","nullable":true,"description":"Field-level details, present on validation errors.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}}}}},"responses":{"NotFound":{"description":"The resource doesn't exist or isn't visible to this caller.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"paths":{"/workrooms/{id}/email_addresses/{email_id}":{"get":{"tags":["Workroom Settings"],"operationId":"retrieveWorkroomEmailAddress","summary":"Retrieve one workroom sending address.","description":"A single configured from-address, with its verification state. An unverified address cannot be used to send.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomEmailAddress"}}}},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```

## PATCH /workrooms/{id}/email\_addresses/{email\_id}

> Update a sender address. Setting \`is\_default=true\` also updates the workroom's \`default\_email\` and \`reply\_to\_email\`.

```json
{"openapi":"3.1.0","info":{"title":"Gleantap API v3","version":"2026-05-27"},"tags":[{"name":"Workroom Settings","description":"Configuration for a workroom — general info, email defaults, SMS templates + compliance text, phone number assignments, and email sender addresses. All PATCH endpoints use an allowlist (unknown fields are silently ignored) and require the `workrooms:configure` scope. Downstream-affecting changes (verified email domains, default SMS number) are validated best-effort against `custom_domains` and `phone_numbers`. Provider credentials (`account_sid`, `auth_token`, etc.) and phone-number verification metadata stay UI-only.\n"}],"servers":[{"url":"https://api.gleantap.com/v3","description":"Production. There is no separate sandbox."}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"gltp_sk_*","description":"The **API Secret** from the Gleantap dashboard under **Settings → API** (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as `gltp_sk_live_<40-hex>`. There is no sandbox: every key acts on the live account.\n\nKeys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default — narrow with `?workroom=` / `Gleantap-Workroom` on each request. Revoke via the dashboard.\n\nFor per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.\n"}},"schemas":{"WorkroomEmailAddressUpdate":{"type":"object","properties":{"user_name":{"type":"string"},"status":{"type":"string"},"is_default":{"type":"boolean"}}},"WorkroomEmailAddress":{"type":"object","description":"A sender address in the workroom's email_topics list. Set `is_default=true` (via PATCH) to make it the workroom's default sender — the write cascades to `default_email` + `reply_to_email` on the workroom.\n","properties":{"id":{"$ref":"#/components/schemas/EmailAddressId"},"object":{"type":"string","enum":["email_address"]},"user_name":{"type":"string","nullable":true},"user_email":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"is_default":{"type":"boolean"}}},"EmailAddressId":{"type":"string","pattern":"^ea_[0-9a-f]{24}$"}}},"paths":{"/workrooms/{id}/email_addresses/{email_id}":{"patch":{"tags":["Workroom Settings"],"operationId":"updateWorkroomEmailAddress","summary":"Update a sender address. Setting `is_default=true` also updates the workroom's `default_email` and `reply_to_email`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomEmailAddressUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkroomEmailAddress"}}}}}}}}}
```
