> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aide.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Patch v1sender rules



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/sender-rules/{id}
openapi: 3.1.0
info:
  title: Aide API
  version: '1'
  description: >-
    Aide's public API. The dashboard, personal access tokens and the MCP server
    all use these endpoints.


    **Authentication.** `Authorization: Bearer oat_…` (a teammate's access
    token) or `Authorization: Bearer aide_live_…` (a workspace API key, created
    by an owner or admin under Settings > Developers). Either is bound to one
    account; every resource is scoped to it, and another account's id answers
    404.


    **API keys** act as the workspace, not as a teammate. Operations that list
    `apiKey` under security accept them; everything else (the session, `me`,
    members, teams, billing, conversations, saved views, notifications, helpdesk
    and widget settings, and API keys themselves) answers 403
    `api_key_not_allowed`. A key with only the `read` scope gets 403
    `insufficient_scope` on writes (every method but `GET`, except `POST
    /v1/knowledge/search`, which only reads). A revoked, expired or unknown key
    answers 401 `invalid_api_key`. Requests are rate limited per key.


    **Webhooks.** Each delivery is a `POST` of the event JSON with
    `Aide-Event-Id`, `Aide-Event-Type`, `Aide-Delivery-Attempt` and
    `Aide-Signature: t=<unix seconds>,v1=<hex>`. `v1` is the HMAC-SHA256 of
    `${t}.${raw body}` keyed with the endpoint secret (`whsec_…`, the whole
    string). For 24 h after a rotation a second `v1`, signed with the previous
    secret, is included; accept the request if any `v1` matches and `t` is
    within 5 minutes. Answer 2xx within 10 s; anything else is retried with
    exponential backoff (8 attempts over about 4 h). An endpoint is disabled
    after 25 failed attempts in a row with no success for 24 h. Deduplicate on
    the event id.


    **Responses.** Successful bodies are wrapped as `{ data }`. Page-numbered
    lists add `metadata`: `total` (exact up to 10,000, then 10,000 with
    `totalIsCapped: true`), `totalIsCapped`, `perPage`, `currentPage`,
    `lastPage` and `hasMore`. `page` runs from 1 to 500, and a page that starts
    past the first 10,000 rows answers 422 `page_too_deep`. `GET
    /v1/conversations` also takes a `cursor` (not with `page`): its
    `metadata.nextCursor` pages on in the same sort without counting, and a
    cursor page has null `total`, `currentPage` and `lastPage`. Message threads
    page with `before` and `meta.nextCursor`.


    **Errors.** Every error is `{ error: { type, code, message, requestId,
    fields? } }`. Validation failures are 422 with one entry per field in
    `fields`.


    **Rate limits.** Throttled routes return `X-RateLimit-Limit` and
    `X-RateLimit-Remaining`; a 429 adds `Retry-After` and `X-RateLimit-Reset`.
servers:
  - url: https://app-api.aide.app
    description: Aide API
security: []
tags:
  - name: Account
  - name: Agent
  - name: AgentEntryPoint
  - name: AgentLinks
  - name: AgentPanelEvent
  - name: AgentPanelSessions
  - name: AgentTestConversation
  - name: Analytics
  - name: ApiKey
  - name: Attachment
  - name: Auth
  - name: Billing
  - name: ChannelActivity
  - name: ChannelConfiguration
  - name: ChannelSettings
  - name: ConnectedApp
  - name: ContactSync
  - name: Conversation
  - name: ConversationAi
  - name: ConversationCustomerContext
  - name: ConversationDraft
  - name: ConversationMacro
  - name: ConversationOrder
  - name: CustomField
  - name: EmailMailbox
  - name: EmailPreferences
  - name: GoogleSessions
  - name: HelpdeskSetting
  - name: Integration
  - name: IntegrationAiAgentRule
  - name: IntegrationSidebar
  - name: Invitation
  - name: KnowledgeCollection
  - name: KnowledgeDocument
  - name: KnowledgeEntity
  - name: KnowledgeSource
  - name: Macro
  - name: Me
  - name: Member
  - name: MessageFeedback
  - name: MessageSender
  - name: Notification
  - name: NotificationChannel
  - name: OauthAuthorization
  - name: Order
  - name: OrderAction
  - name: Plan
  - name: PolicyQuestion
  - name: Product
  - name: ProductPairing
  - name: Proposal
  - name: ReplyTemplate
  - name: RoutingRule
  - name: SavedView
  - name: Scenario
  - name: ScenarioBackfill
  - name: Schedule
  - name: SenderClassification
  - name: SenderRule
  - name: ShopifyStaffLinks
  - name: SlaPolicy
  - name: Team
  - name: Topic
  - name: TopicSuggestion
  - name: WebhookEndpoint
  - name: Widgets
paths:
  /v1/sender-rules/{id}:
    patch:
      tags:
        - SenderRule
      operationId: sender_rule.update
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                enabled:
                  enum:
                    - '1'
                    - 1
                    - 'true'
                    - true
                    - 'on'
                    - '0'
                    - 0
                    - 'false'
                    - false
                match:
                  enum:
                    - all
                    - any
                conditions:
                  type: array
                  items:
                    anyOf:
                      - type: object
                        properties:
                          field:
                            enum:
                              - sender_address
                              - recipient_address
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              type: string
                              format: email
                              maxLength: 255
                            minItems: 1
                            maxItems: 1000
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - sender_domain
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              type: string
                              maxLength: 255
                              pattern: ^(?=.{1,255}$)([a-z0-9-]+\.)+[a-z]{2,}$
                            minItems: 1
                            maxItems: 1000
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            enum:
                              - sender_name
                              - subject
                              - body
                          op:
                            type: string
                            enum:
                              - contains
                          value:
                            type: string
                            minLength: 1
                            maxLength: 500
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - subject
                          op:
                            type: string
                            enum:
                              - starts_with
                          value:
                            type: string
                            minLength: 1
                            maxLength: 500
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            enum:
                              - sender_address
                              - recipient_address
                              - sender_name
                              - subject
                              - body
                          op:
                            type: string
                            enum:
                              - matches
                          value:
                            type: string
                            minLength: 1
                            maxLength: 200
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - sender_phone
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              type: string
                              pattern: ^\+[1-9](?:[\s().-]{0,2}\d){7,14}$
                            minItems: 1
                            maxItems: 1000
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - sender_id
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 128
                            minItems: 1
                            maxItems: 1000
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - channel
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              enum:
                                - email
                                - gorgias
                                - zendesk
                                - front
                                - whatsapp
                                - messenger
                                - instagram
                            minItems: 1
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - inbox
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 128
                            minItems: 1
                            maxItems: 1000
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - thread_kind
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              enum:
                                - dm
                                - comment
                            minItems: 1
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - posted_via
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              enum:
                                - email
                                - web_form
                                - chat
                                - chat_transcript
                                - api
                                - helpdesk
                                - automation
                                - social
                                - other
                            minItems: 1
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - author
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              enum:
                                - customer
                                - teammate
                                - system
                            minItems: 1
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                  minItems: 1
                  maxItems: 30
                exceptions:
                  type: array
                  items:
                    anyOf:
                      - type: object
                        properties:
                          field:
                            enum:
                              - sender_address
                              - recipient_address
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              type: string
                              format: email
                              maxLength: 255
                            minItems: 1
                            maxItems: 1000
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - sender_domain
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              type: string
                              maxLength: 255
                              pattern: ^(?=.{1,255}$)([a-z0-9-]+\.)+[a-z]{2,}$
                            minItems: 1
                            maxItems: 1000
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            enum:
                              - sender_name
                              - subject
                              - body
                          op:
                            type: string
                            enum:
                              - contains
                          value:
                            type: string
                            minLength: 1
                            maxLength: 500
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - subject
                          op:
                            type: string
                            enum:
                              - starts_with
                          value:
                            type: string
                            minLength: 1
                            maxLength: 500
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            enum:
                              - sender_address
                              - recipient_address
                              - sender_name
                              - subject
                              - body
                          op:
                            type: string
                            enum:
                              - matches
                          value:
                            type: string
                            minLength: 1
                            maxLength: 200
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - sender_phone
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              type: string
                              pattern: ^\+[1-9](?:[\s().-]{0,2}\d){7,14}$
                            minItems: 1
                            maxItems: 1000
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - sender_id
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 128
                            minItems: 1
                            maxItems: 1000
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - channel
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              enum:
                                - email
                                - gorgias
                                - zendesk
                                - front
                                - whatsapp
                                - messenger
                                - instagram
                            minItems: 1
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - inbox
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 128
                            minItems: 1
                            maxItems: 1000
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - thread_kind
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              enum:
                                - dm
                                - comment
                            minItems: 1
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - posted_via
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              enum:
                                - email
                                - web_form
                                - chat
                                - chat_transcript
                                - api
                                - helpdesk
                                - automation
                                - social
                                - other
                            minItems: 1
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                      - type: object
                        properties:
                          field:
                            type: string
                            enum:
                              - author
                          op:
                            type: string
                            enum:
                              - in
                          value:
                            type: array
                            items:
                              enum:
                                - customer
                                - teammate
                                - system
                            minItems: 1
                            uniqueItems: true
                        required:
                          - field
                          - op
                          - value
                        additionalProperties: false
                  maxItems: 30
                outcome:
                  enum:
                    - customer
                    - automated
                    - ignore
                    - form_submission
                    - transcript
                relay:
                  type:
                    - object
                    - 'null'
                  properties:
                    email:
                      type:
                        - string
                        - 'null'
                      minLength: 1
                      maxLength: 60
                    name:
                      type:
                        - string
                        - 'null'
                      minLength: 1
                      maxLength: 60
                  required: []
                  additionalProperties: false
      responses:
        '200':
          description: OK
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SenderRule'
                required:
                  - data
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        default:
          $ref: '#/components/responses/Error'
      security:
        - accessToken: []
components:
  headers:
    X-RateLimit-Limit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        type: integer
    Retry-After:
      description: Seconds until the window resets.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: When the window resets.
      schema:
        type: string
        format: date-time
  schemas:
    SenderRule:
      type: object
      properties:
        object:
          type: string
          const: sender_rule
        name:
          type: string
        match:
          type: string
          enum:
            - all
            - any
        createdAt:
          type:
            - string
            - 'null'
        id:
          type: string
        updatedAt:
          type:
            - string
            - 'null'
        position:
          type: number
        enabled:
          type: boolean
        outcome:
          type: string
          enum:
            - automated
            - customer
            - form_submission
            - ignore
            - transcript
        conditions:
          type: array
          items:
            anyOf:
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                      enum:
                        - customer
                        - system
                        - teammate
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: author
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                      enum:
                        - email
                        - front
                        - gorgias
                        - instagram
                        - messenger
                        - whatsapp
                        - zendesk
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: channel
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: inbox
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                      enum:
                        - api
                        - automation
                        - chat
                        - chat_transcript
                        - email
                        - helpdesk
                        - other
                        - social
                        - web_form
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: posted_via
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: sender_domain
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: sender_id
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: sender_phone
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: string
                  op:
                    type: string
                    const: starts_with
                  field:
                    type: string
                    const: subject
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                      enum:
                        - comment
                        - dm
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: thread_kind
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: string
                  op:
                    type: string
                    const: matches
                  field:
                    type: string
                    enum:
                      - body
                      - recipient_address
                      - sender_address
                      - sender_name
                      - subject
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: string
                  op:
                    type: string
                    const: contains
                  field:
                    type: string
                    enum:
                      - body
                      - sender_name
                      - subject
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    enum:
                      - recipient_address
                      - sender_address
                required:
                  - value
                  - op
                  - field
        exceptions:
          type: array
          items:
            anyOf:
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                      enum:
                        - customer
                        - system
                        - teammate
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: author
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                      enum:
                        - email
                        - front
                        - gorgias
                        - instagram
                        - messenger
                        - whatsapp
                        - zendesk
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: channel
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: inbox
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                      enum:
                        - api
                        - automation
                        - chat
                        - chat_transcript
                        - email
                        - helpdesk
                        - other
                        - social
                        - web_form
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: posted_via
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: sender_domain
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: sender_id
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: sender_phone
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: string
                  op:
                    type: string
                    const: starts_with
                  field:
                    type: string
                    const: subject
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                      enum:
                        - comment
                        - dm
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    const: thread_kind
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: string
                  op:
                    type: string
                    const: matches
                  field:
                    type: string
                    enum:
                      - body
                      - recipient_address
                      - sender_address
                      - sender_name
                      - subject
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: string
                  op:
                    type: string
                    const: contains
                  field:
                    type: string
                    enum:
                      - body
                      - sender_name
                      - subject
                required:
                  - value
                  - op
                  - field
              - type: object
                properties:
                  value:
                    type: array
                    items:
                      type: string
                  op:
                    type: string
                    const: in
                  field:
                    type: string
                    enum:
                      - recipient_address
                      - sender_address
                required:
                  - value
                  - op
                  - field
        relay:
          type:
            - object
            - 'null'
          properties:
            email:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
          required:
            - email
            - name
        matches7d:
          type: number
        lastMatchedAt:
          type:
            - string
            - 'null'
      required:
        - object
        - name
        - match
        - createdAt
        - id
        - updatedAt
        - position
        - enabled
        - outcome
        - conditions
        - exceptions
        - relay
        - matches7d
        - lastMatchedAt
    Error:
      type: object
      description: Every error response, whatever the status (app/exceptions/handler.ts).
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - api_error
                - authentication_error
                - invalid_request_error
                - permission_error
                - rate_limit_error
            code:
              type: string
              description: Stable, machine-readable error code.
            message:
              type: string
            requestId:
              type: string
            fields:
              type: array
              description: Per-field problems, on validation errors.
              items:
                type: object
                properties:
                  field:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                required:
                  - field
                  - code
                  - message
          required:
            - type
            - code
            - message
            - requestId
      required:
        - error
  responses:
    Unauthenticated:
      description: Missing or invalid credentials (`authentication_error`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The credential may not do this (`permission_error`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: No such resource for this credential (`not_found`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationFailed:
      description: The request has invalid fields (`validation_failed`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Rate limited (`too_many_requests`).
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error:
      description: Any other error, in the same envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    accessToken:
      type: http
      scheme: bearer
      bearerFormat: oat_…
      description: An access token, bound to one account.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.