> ## Documentation Index > Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt > Use this file to discover all available pages before exploring further. # Update suppression > Update suppression. Requires the IAM action **`email:UpdateSuppression`**. See [EMAIL permissions](/email/permissions) for the full list, what each one covers, and an example policy. ## OpenAPI ````yaml /api-reference/specs/email.yaml patch /v1/suppressions/{suppression_id} openapi: 3.0.3 info: title: Basaltic Email API version: 1.0.0 description: > Regional API for sending and receiving email, identities and DNS records, templates, configuration sets, IP pools, recipient rules, message content and attachments. Identities must be verified separately in every region. Create an identity, publish its dns_records, then request verification. Only verified identities can send or enable receiving. Request references accept a UUID, an account-unique name or a CRN of the expected resource type. Names are immutable. Malformed references or the wrong resource type/region return 400; missing or foreign-account references return 404. Resource paths use UUIDs. List filters are exact, account-scoped and applied before pagination; missing or foreign references return empty results. Sent and received message content expires after 30 days. Attachment objects follow their bucket lifecycle independently. Use Telemetry for aggregate metrics and the diagnostic endpoints for individual events and DMARC report records. contact: name: Basaltic Support email: ping@basaltic.sh license: name: Proprietary url: https://basaltic.sh/terms servers: - url: https://email.{region}.basaltic.sh description: Regional API endpoint variables: region: default: sa-saopaulo-1 description: Region code security: - BearerAuth: [] tags: - name: Email description: Customer-facing email sending (regional). paths: /v1/suppressions/{suppression_id}: patch: tags: - Email summary: Update suppression description: Update suppression. operationId: updateSuppression parameters: - name: suppression_id in: path required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSuppressionRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SuppressionResponse' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Conflicting state. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Quota or rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal error. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: Dependency unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: UpdateSuppressionRequest: type: object properties: description: type: string expires_at: type: string format: date-time nullable: true description: Null makes the suppression permanent; omission preserves its expiry. SuppressionResponse: type: object required: - suppression properties: suppression: $ref: '#/components/schemas/Suppression' Error: type: object required: - error properties: error: type: object required: - code - message - request_id properties: code: type: string description: Error code identifying the type of error example: INVALID_INPUT message: type: string description: Human-readable error message example: Invalid request parameters params: type: object additionalProperties: true description: >- Optional non-sensitive values for interpolation of localized errors, keyed by error code. Never present for server errors. example: instances: 2 pools: 0 request_id: type: string format: uuid description: Request ID for debugging example: 550e8400-e29b-41d4-a716-446655440000 Suppression: type: object required: - id - crn - address - reason - created_at - updated_at properties: id: type: string format: uuid crn: type: string address: type: string reason: type: string enum: - auto_bounce - auto_complaint - manual description: type: string source_message: allOf: - $ref: '#/components/schemas/ResourceRef' example: id: 3c90c3cc-0d44-4b50-8888-8dd25736052a crn: >- crn:email:sa-saopaulo-1:acme:message/3c90c3cc-0d44-4b50-8888-8dd25736052a expires_at: type: string format: date-time nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time ResourceRef: type: object required: - id - crn properties: id: type: string format: uuid example: 288aa1e9-bbf5-5584-bce9-6a688f06d8a1 crn: type: string example: crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1 name: type: string description: >- Display label at response time — the resource's name where it has one, otherwise its human label (an invoice number, an account display name). Absent when the target is gone. Not a lookup key. example: Brazil securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: | An OAuth 2.0 bearer token, sent as `Authorization: Bearer `. This is the recommended way to authenticate. Get one by exchanging a service account's access key pair at `POST /v1/oauth/token` with `grant_type=client_credentials`. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you. ``` curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \ https://iam.basaltic.sh/v1/oauth/token ``` Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.