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

# Set or clear phone-number verification timestamp

> Marks a specific phone number on the contact as verified (or clears verification when verifiedAt is null). Operates on the matching entry inside the phoneNumber array; org-scoped unless caller is SUPERADMIN.



## OpenAPI

````yaml /api-reference/openapi.yaml patch /api/contacts/{id}/phone-number/verify
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/contacts/{id}/phone-number/verify:
    patch:
      tags:
        - Contacts
      summary: Set or clear phone-number verification timestamp
      description: >-
        Marks a specific phone number on the contact as verified (or clears
        verification when verifiedAt is null). Operates on the matching entry
        inside the phoneNumber array; org-scoped unless caller is SUPERADMIN.
      operationId: patch_contact_phone_number_verify
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetContactPhoneVerificationRequest'
      responses:
        '200':
          description: Phone verification updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactWrappedMutationResponse'
        '400':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorResponse'
        '404':
          description: Contact or phone number not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    SetContactPhoneVerificationRequest:
      type: object
      properties:
        phoneNumber:
          type: string
          description: Phone-number value (e.g. +14165551234) of the entry to update.
        verifiedAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            ISO date marking when the number was verified. Pass null to clear
            verification.
      required:
        - phoneNumber
      additionalProperties: true
      example:
        phoneNumber: '+14165550100'
        verifiedAt: '2026-05-15T09:12:00.000Z'
    ContactWrappedMutationResponse:
      type: object
      properties:
        message:
          type: string
        data:
          type: object
          properties:
            contact:
              $ref: '#/components/schemas/ContactDto'
          required:
            - contact
          additionalProperties: true
      required:
        - data
      additionalProperties: true
      example:
        message: Contact verified
        data:
          contact:
            _id: 64f0a1b2c3d4e5f6a7b8c9d0
            firstName: Jane
            lastName: Doe
    LegacyErrorResponse:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        data: {}
      additionalProperties: true
      example:
        error: Attachment not found
        message: Attachment not found
    ContactDto:
      type: object
      properties:
        _id:
          type: string
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        phoneNumber:
          nullable: true
          oneOf:
            - type: string
            - type: array
              items:
                $ref: '#/components/schemas/ContactPhoneNumber'
        secondaryPhoneNumber:
          type: array
          nullable: true
          items:
            type: string
        email:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        pipelineId:
          type: string
          nullable: true
        pipelineStage:
          type: string
          nullable: true
        organizationId:
          type: string
          nullable: true
        userId:
          type: string
          nullable: true
        createdBy:
          type: string
          nullable: true
        assignees:
          type: array
          items: {}
        createdAt:
          type: string
          format: date-time
          nullable: true
        updatedAt:
          type: string
          format: date-time
          nullable: true
        existingConversationId:
          type: string
          nullable: true
          description: >-
            Set on responses from /api/contacts/inactive when called with
            includeExisting=true. Identifies the caller-accessible conversation
            in the requested channel; clients should route to this conversation
            instead of creating a new one.
      additionalProperties: true
      example:
        _id: 64f0a1b2c3d4e5f6a7b8c9d0
        firstName: Jane
        lastName: Doe
        phoneNumber:
          - value: '+14165550100'
            isPrimary: true
        secondaryPhoneNumber: []
        email: jane.doe@example.com
        status: New Lead
        pipelineId: 64f0a1b2c3d4e5f6a7b8c9d1
        pipelineStage: 64f0a1b2c3d4e5f6a7b8c9d2
        organizationId: 64f0a1b2c3d4e5f6a7b8c9d3
        userId: 64f0a1b2c3d4e5f6a7b8c9d4
        createdBy: 64f0a1b2c3d4e5f6a7b8c9d4
        assignees:
          - 64f0a1b2c3d4e5f6a7b8c9d4
        createdAt: '2026-05-01T14:30:00.000Z'
        updatedAt: '2026-05-15T09:12:00.000Z'
    ContactPhoneNumber:
      type: object
      properties:
        value:
          type: string
        isPrimary:
          type: boolean
      required:
        - value
      additionalProperties: true
      example:
        value: '+14165550100'
        isPrimary: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````