> ## 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.

# Stáhnout opt-out seznam

> Vrací předpodepsanou URL (platnou 60 sekund) pro stažení opt-out seznamu ve formátu CSV. Opt-out seznam se uplatňuje na zprávy s tagem `promotional`.



## OpenAPI

````yaml /openapi/rest/restapi_v1.yaml get /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:
    get:
      tags:
        - blacklist
      summary: Stáhnout opt-out seznam
      description: >-
        Vrací předpodepsanou URL (platnou 60 sekund) pro stažení opt-out seznamu
        ve formátu CSV. Opt-out seznam se uplatňuje na zprávy s tagem
        `promotional`.
      parameters:
        - name: subid
          in: query
          required: false
          schema:
            type: string
            default: default
          description: Id podúčtu.
      responses:
        '200':
          description: URL ke stažení
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  url:
                    type: string
                    description: Předpodepsaná URL ke stažení, platná 60 sekund.
              example:
                success: true
                url: >-
                  https://smsmngr-managed-contactlist.s3.amazonaws.com/...&X-Amz-Expires=60...
        '404':
          description: Opt-out seznam nenalezen (zatím nejsou uložena žádná čísla)
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
                message: Optout not found
        '500':
          description: Interní chyba
          content:
            application/json:
              schema:
                type: object
              example:
                success: false
                message: Failed to generate download URL
components:
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````