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

# Mark a phone or email as Do-Not-Call/Contact

> Record a Do-Not-Call/Contact request captured by an AI agent's `mark_dnc` tool during a conversation. Adds the phone number or email to your suppression list — and, for voice and SMS, to your Do-Not-Call list — then marks any matching contact as Do-Not-Contact so it is excluded from the next campaign audience, and fires the `agent.dnc.marked` webhook. Idempotent — repeating the call for an already-suppressed address returns success without creating duplicates or re-firing the webhook. Requires at least one of `phone` or `email`.



## OpenAPI

````yaml /openapi.yaml post /api/v1/agents/dnc
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/agents/dnc:
    post:
      tags:
        - Agents
      summary: Mark a phone or email as Do-Not-Call/Contact
      description: >-
        Record a Do-Not-Call/Contact request captured by an AI agent's
        `mark_dnc` tool during a conversation. Adds the phone number or email to
        your suppression list — and, for voice and SMS, to your Do-Not-Call list
        — then marks any matching contact as Do-Not-Contact so it is excluded
        from the next campaign audience, and fires the `agent.dnc.marked`
        webhook. Idempotent — repeating the call for an already-suppressed
        address returns success without creating duplicates or re-firing the
        webhook. Requires at least one of `phone` or `email`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                phone:
                  type: string
                  description: >-
                    E.164 phone number (e.g. +14155551234). At least one of
                    phone/email is required.
                email:
                  type: string
                  format: email
                channel:
                  type: string
                  enum:
                    - all
                    - voice
                    - sms
                    - email
                    - whatsapp
                  description: >-
                    Which channel(s) the suppression applies to. Defaults to
                    all.
                reason:
                  type: string
                  maxLength: 500
                conversation_id:
                  type: string
                  maxLength: 120
            example:
              phone: '+14155551234'
              channel: all
              reason: Customer asked not to be contacted again
      responses:
        '200':
          description: Suppression persisted (or already in effect).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - suppressed
                      channel:
                        type: string
                      reason:
                        type: string
                        nullable: true
                      new_suppression_rows:
                        type: integer
                      suppressed_voice_dnc:
                        type: boolean
                      contacts_flipped:
                        type: integer
                        description: Number of matching contacts marked as Do-Not-Contact.
                      phone:
                        type: string
                      email:
                        type: string
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '422':
          description: >-
            Neither phone nor email was provided, or the phone/email failed
            validation.
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````