> ## Documentation Index > Fetch the complete documentation index at: https://docs.famulor.io/llms.txt > Use this file to discover all available pages before exploring further. # Change a suppression entry > Changes the direction and/or the reason of one active suppression entry. The entry keeps its contact identity, scope and source. Changing the direction is recorded in the consent history: lifting the outbound block appends an opt-in event, adding a direction an opt-out event. `inbound` and `both` need an entry with a phone number or email address. Send at least one of `direction` or `reason`; `reason: null` or an empty string clears it. **Required scope:** `suppression:write`. ## OpenAPI ````yaml /api-reference/openapi.json patch /suppression-list/{id} openapi: 3.1.0 info: title: Famulor API version: 1.0.0 description: >- REST API for Famulor. Authenticate with an API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a Bearer token. Every response uses a consistent envelope: `{ "data": ... , "meta": { ... } }` on success and `{ "error": { "code", "message" } }` on failure. List endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`; `meta.pagination.total` carries the total match count. REST operations require API Access through the workspace plan or a recurring add-on. Without it, regular operations return `403 api_access_required`. The invoice-payment and billing-portal operations remain available with a valid `billing:write` credential after a failed plan payment so an authorized owner, admin, or billing member can recover billing. The same customer-facing capabilities are available as MCP tools at `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using the same credentials, scopes, and workspace access. MCP availability is controlled separately by Connect AI / MCP, not by API Access. servers: - url: https://app.famulor.io/api/v1 description: Hosted platform. - url: https://{domain}/api/v1 description: White-label tenant domain — same paths, tenant branding. variables: domain: default: app.famulor.io description: Your white-label tenant domain. security: - bearerAuth: [] tags: - name: Account description: Self-inspection of the calling credential. - name: Migrations description: Preview and import data from supported legacy platforms. - name: Assistants description: Create and manage voice assistants. - name: Tools description: >- Reusable tools (HTTP APIs, external MCP servers and actions of connected apps) assistants can call mid-conversation. - name: Voices description: Browse the text-to-speech voice library. - name: Calls description: Start outbound calls and read call history, transcripts and recordings. - name: History description: Unified conversation history across calls, messaging and assistant emails. - name: Campaigns description: Outbound calling campaigns with a compliant power dialer. - name: Leads description: Manage Audience contacts across campaigns, channels and Call QA metrics. - name: Segments description: >- Saved, dynamic lead filters — reusable audience definitions used for Audience search and campaign lead assignment. - name: Suppression description: Cross-channel marketing opt-outs and active workspace suppression records. - name: Callbacks description: >- Scheduled callbacks booked by the Schedule callback tool across voice, chat, and email. - name: Phone Numbers description: Marketplace numbers and customer-provided numbers. - name: Famulor Loop description: >- Personal business-phone access, directory, presence, devices, and Loop call recents. - name: SIP Trunks description: Bring your own SIP provider and numbers. - name: Carrier Connections description: Connect a supported carrier account and import its existing phone numbers. - name: Knowledge Bases description: RAG knowledge bases and documents for assistants. - name: Settings description: Workspace-level settings such as caller-memory defaults. - name: Billing description: Balance and transaction ledger of the API key's workspace. - name: Automations description: >- Native workspace automations — list, create, update, trigger. Requires Automations in the workspace plan. - name: Milian Missions description: Recurring jobs that Milian runs unattended on schedule. - name: Integrations description: >- Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google Calendar, Outlook, native booking engine). Assign them to assistants to provide availability and booking tools, plus provider-supported appointment lookup, cancellation, and rescheduling. - name: Bookings description: >- Native booking engine — event types with weekly availability, public booking pages at /book/{workspace}/{slug}, and the bookings they produce. - name: Dashboards description: >- Custom analytics dashboards, reusable widgets, and tenant-scoped performance analytics. Requires Custom dashboards in the workspace plan. - name: Catalog description: >- Read-only platform catalogs — available models, supported assistant languages, and prompt templates. - name: Simulations description: Assistant simulation tests (plan-gated). - name: Versions description: Assistant configuration version history. - name: Caller IDs description: Outbound caller ID verification. - name: Widgets description: Web widget connectors. - name: Messaging description: >- Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK). Includes conversation delay, inactivity end, and conversation-ended webhooks. - name: QA description: Cohort AI Quality Assurance runs over call transcripts. - name: White Label description: >- Manage white-label customer accounts, defaults, credit transfers and customer plan offers. Each endpoint documents its required scope and workspace eligibility. - name: API Keys description: >- Self-service API keys for the calling workspace or a same-brand workspace where the credential's user is owner/admin. A key can only mint further keys with a scope subset of its own. - name: Workspaces description: >- List visible workspaces, create an additional workspace for the key owner, and mint a dedicated credential for a selected owner/admin workspace. - name: SMS description: Outbound SMS from workspace phone numbers. - name: Milian description: >- Ask Milian, the AI co-worker in your workspace, and start voice sessions with it. - name: Translation description: >- Live translation sessions that interpret a conversation between two languages. - name: Shopify description: Native Shopify app store connections, assistant tools and activity. - name: Avatars description: Private custom avatars and widget avatar selection. - name: Webhook Subscriptions description: >- Signed workspace event subscriptions, independent of existing destinations. paths: /suppression-list/{id}: patch: tags: - Suppression summary: Change a suppression entry description: >- Changes the direction and/or the reason of one active suppression entry. The entry keeps its contact identity, scope and source. Changing the direction is recorded in the consent history: lifting the outbound block appends an opt-in event, adding a direction an opt-out event. `inbound` and `both` need an entry with a phone number or email address. Send at least one of `direction` or `reason`; `reason: null` or an empty string clears it. **Required scope:** `suppression:write`. operationId: updateSuppressionEntry parameters: - name: id in: path required: true schema: type: string format: uuid description: Suppression entry ID (from `GET /suppression-list`). requestBody: required: true content: application/json: schema: type: object properties: direction: $ref: '#/components/schemas/SuppressionDirection' reason: type: - string - 'null' maxLength: 500 description: New reason. `null` or an empty string clears it. minProperties: 1 example: direction: both reason: Daily spam calls responses: '200': description: The updated entry. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/SuppressionEntry' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': description: >- The entry was changed at the same time (for example by an opt-out). Read it again and retry. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: >- Invalid `direction`, or `inbound`/`both` for an entry without phone number or email address. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/RequestProtectionUnavailable' components: schemas: SuppressionDirection: type: string enum: - outbound - inbound - both description: >- `outbound`: the contact is never called, texted, or emailed (scope applies). `inbound`: incoming calls from the phone number are hung up immediately and incoming SMS, WhatsApp, other messenger, and email messages from that phone or email get no AI reply and no reply charge; they stay visible in History (incoming SMS and RCS on purchased numbers still cost the normal receive fee). Inbound blocking covers every channel of the identity regardless of scope. `both`: both. Automatic opt-outs (STOP replies, verbal do-not-call requests, email unsubscribes, imports) are always `outbound`. Opt-in (for example an SMS START reply) only lifts the outbound part. example: outbound SuppressionEntry: type: object required: - id - contact_id - phone - email - identity_type - identity - scope - origin_channel - purpose - reason - source - mode_at_opt_out - direction - created_at properties: id: type: string format: uuid contact_id: type: string format: uuid nullable: true description: Linked workspace contact/lead ID, when resolved. phone: type: string nullable: true description: Phone number in E.164 format. example: '+4930123456' email: type: string format: email nullable: true example: contact@example.com identity_type: type: string nullable: true enum: - phone - email - platform_user identity: type: string nullable: true description: Normalized public contact identity used for this suppression. scope: type: string enum: - all - voice - sms - email - telegram - slack - messenger - teams - discord - gchat - x - whatsapp - linear - notion - twitch - mattermost - webex - lark - line - sendblue - linq - zernio - freshdesk - gmail - outlook - zendesk - servicenow - intercom - zoho_mail - agent_mail - instagram - zulip description: >- `all` blocks every linked marketing channel; a channel value blocks only that channel. origin_channel: $ref: '#/components/schemas/ConsentChannel' purpose: type: string const: marketing reason: type: string nullable: true example: Unsubscribe request source: type: string description: >- How the opt-out was recorded, for example `api`, `manual`, `keyword`, `agent`, `unsubscribe`, or `import`. mode_at_opt_out: $ref: '#/components/schemas/ConsentMode' direction: $ref: '#/components/schemas/SuppressionDirection' created_at: type: string format: date-time ErrorEnvelope: type: object description: Error envelope returned by every /api/v1 endpoint on failure. required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - unauthorized - forbidden - api_access_required - not_found - invalid_request - rate_limited - conflict - telephony_configuration_error - telephony_unavailable - destination_forbidden - internal_error - service_unavailable - verification_address_required - bundle_address_missing description: >- Stable, machine-readable error code. `service_unavailable` is returned by POST /bookings and GET /booking-event-types/{id}/slots specifically when the availability engine could not be reached (see AvailabilityOrProtectionUnavailable). `verification_address_required` and `bundle_address_missing` are returned by POST /phone-numbers when the verification behind the number has no address (see the operation description). message: type: string description: Human-readable description of the error. reason: type: string description: >- Optional, more specific and stable reason for this error, for example `plan_required`, `read_only_role` or `missing_scope`. Branch on `code` first: `reason` is only present on some errors, and new values may be added. Campaign operations use `attestation_required` (400, `compliance_attestation` missing on launch), `launch_required` (400, a sequence campaign was never launched; launch it or start it with `compliance_attestation`), `sequence_changed` (409, the sequence changed after `sequence_hash` was taken), `campaign_sequences_unavailable` (403, the plan does not include Campaign sequences), `campaign_extension_unavailable` (503 `service_unavailable`, the campaign feature is not available yet) and `analytics_timeout` (504 `service_unavailable`, the campaign analytics took too long; choose a shorter period). hint: type: string description: >- Optional recovery advice that is safe to show to the end user, for example which settings page to open. ConsentChannel: type: string enum: - voice - sms - email - telegram - slack - messenger - teams - discord - gchat - x - whatsapp - linear - notion - twitch - mattermost - webex - lark - line - sendblue - linq - zernio - freshdesk - gmail - outlook - zendesk - servicenow - intercom - zoho_mail - agent_mail - instagram - zulip description: >- Communication channel where an opt-out originated or on which suppression should be evaluated. ConsentMode: type: string enum: - universal - per_channel description: >- `universal` suppresses all linked marketing channels; `per_channel` suppresses only the originating channel. responses: BadRequest: description: Invalid request body or parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: invalid_request message: '"to_number" is required (E.164 format, e.g. +4930123456).' Unauthorized: description: Missing, invalid, expired or revoked API key / access token. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: unauthorized message: Invalid API key. Forbidden: description: >- The credential lacks the required scope or role, or the workspace does not have the required capability. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: scopeDenied: summary: Required scope is missing value: error: code: forbidden message: >- This API key is missing the required scope "assistants:write". apiAccessRequired: summary: API Access is not available value: error: code: api_access_required message: >- API Access is not available for this workspace. Review Settings → Plan. NotFound: description: Resource not found (or it belongs to another workspace). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: not_found message: Assistant not found RateLimited: description: Too many requests. Retry after the indicated delay. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: rate_limited message: Too many requests. Retry after the indicated delay. RequestProtectionUnavailable: description: Request protection is temporarily unavailable. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: internal_error message: Request protection is temporarily unavailable. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as `assistants:read`, `calls:write`, `campaigns:write`, `automations:read`, `dashboards:read`, `dashboards:write`, `leads:write`, `segments:write`, `loop:read`, `loop:write`, `phone_numbers:write`, `sip_trunks:write`, `knowledge:write`, `voices:read`, `billing:read`, `billing:write`, `settings:write`, `platform:read`, `platform:write`; a `*:write` scope implies the matching `*:read`. Automation and dashboard endpoints also accept the legacy `calls:*` scope. Keys without scope restrictions have full access within the workspace's available capabilities. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.