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

# Přidat čísla na opt-out seznam

> Přidá telefonní čísla na opt-out seznam účtu. Čísla jsou normalizována a zpracovávána asynchronně — volání vrací počet přijatých čísel.




## OpenAPI

````yaml /openapi/rest/restapi_v1.yaml post /optout
openapi: 3.1.0
info:
  title: REST API SmsManager
  description: >
    REST API pro správu vašeho účtu SmsManager: API klíče, kredit, fakturace,
    kontaktní seznamy (blacklist / opt-out), zjišťování stavu zpráv, přijaté
    zprávy a podpora hromadného odesílání.


    ## Autentizace


    Pro všechny požadavky je vyžadován API klíč — zasílejte jej v HTTP hlavičce
    `x-api-key`. Svůj API klíč najdete v [nastavení
    účtu](https://app.smsmanager.com/api-cloud).


    Pro odesílání zpráv použijte [JSON API v2](https://api.smsmngr.com/v2).
  version: v1
  contact:
    url: https://smsmanager.com
    email: cc@smsmanager.com
servers:
  - url: https://rest-api.smsmngr.com/v1
    description: Produkční server
security:
  - x-api-key: []
tags:
  - name: api
    x-displayName: API klíče
    x-group: API klíče
    description: >
      Správa API klíčů: profil aktuálního klíče, vytváření a správa podřízených
      klíčů.
  - name: credit
    x-displayName: Kredit
    x-group: Kredit
    description: |
      Stav kreditu, ceník, objednatelné služby a upozornění na nízký kredit.
  - name: billing
    x-displayName: Fakturace
    x-group: Fakturace
    description: |
      Fakturační kontakt, faktury a dobití kreditu bankovním převodem.
  - name: status
    x-displayName: Stav zpráv
    x-group: Stav zpráv
    description: |
      Stav odeslaných zpráv a agregované statistiky odesílání.
  - name: inbox
    x-displayName: Přijaté zprávy
    x-group: Přijaté zprávy
    description: |
      Přijaté (příchozí) zprávy.
  - name: blacklist
    x-displayName: Blacklist a Opt-out
    x-group: Blacklist a Opt-out
    description: >
      Spravované kontaktní seznamy. Blacklist blokuje všechny zprávy na uvedená
      čísla; opt-out seznam blokuje zprávy s tagem `promotional`.
  - name: messaging
    x-displayName: Hromadné odesílání
    x-group: Hromadné odesílání
    description: >
      Podpůrné endpointy pro hromadné odesílání: URL pro nahrání hromadných
      souborů a rušení naplánovaných zpráv.
  - name: partner
    x-displayName: Partneři a integrace
    x-group: Partneři a integrace
    description: >
      Partnerský onboarding, integrace konektorů a registrace push
      zařízení/příjemců.
paths:
  /optout:
    post:
      tags:
        - blacklist
      summary: Přidat čísla na opt-out seznam
      description: >
        Přidá telefonní čísla na opt-out seznam účtu. Čísla jsou normalizována a
        zpracovávána asynchronně — volání vrací počet přijatých čísel.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - to
              properties:
                to:
                  type: string
                  description: Seznam telefonních čísel oddělených novým řádkem.
                  example: |-
                    420777123456
                    420777654321
                subid:
                  type: string
                  default: default
                  description: Id podúčtu.
            examples:
              Add numbers:
                value:
                  to: |-
                    420777123456
                    776654321
      responses:
        '200':
          description: Čísla přijata
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  accepted:
                    type: integer
                  invalid:
                    type: array
                    items:
                      type: string
              example:
                success: true
                accepted: 2
                invalid: []
        '400':
          description: Špatný požadavek
          content:
            application/json:
              schema:
                type: object
              examples:
                Missing to:
                  value:
                    success: false
                    message: Missing 'to'
                No valid numbers:
                  value:
                    success: false
                    message: No valid phone numbers
                    invalid:
                      - not-a-number
        '500':
          description: Interní chyba
          content:
            application/json:
              schema:
                type: object
              example:
                success: false
                message: Enqueue failed
components:
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````