> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/llms.txt > Use this file to discover all available pages before exploring further. # Pausar campanha > Vale no lote seguinte: o que já está com o provedor termina. ## OpenAPI ````yaml POST /v1/clubs/{clubId}/campaigns/{campaignId}/pause openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: outgoing-webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: community - name: mentorships - name: agents - name: lives - name: students - name: auth - name: campaigns - name: workflows - name: email paths: /v1/clubs/{clubId}/campaigns/{campaignId}/pause: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/CampaignId' post: tags: - campaigns summary: Pausa o envio description: | Vale no LOTE seguinte: o que já está com o provedor termina, o resto espera. Só em `sending` (`campaign_not_sending`, 409). operationId: pauseCampaign responses: '200': description: A campanha pausada content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > Id público da organização — o mesmo que `GET /v1/me` devolve em `organization_id`. Na URL o recurso se chama **club**; no contrato e no domínio, organization. A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o que as pessoas leem. É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer. O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso. schema: type: string format: uuid CampaignId: name: campaignId in: path required: true schema: type: string format: uuid schemas: CampaignResponse: type: object required: - data properties: data: $ref: '#/components/schemas/Campaign' Campaign: type: object required: - id - name - status - subject - preheader - blocks - audience - created_at - updated_at properties: id: type: string format: uuid name: type: string status: $ref: '#/components/schemas/CampaignStatus' subject: type: string preheader: type: string reply_to: type: string nullable: true blocks: type: array items: $ref: '#/components/schemas/MailBlock' audience: $ref: '#/components/schemas/CampaignAudience' scheduled_at: type: string format: date-time nullable: true started_at: type: string format: date-time nullable: true description: Quando a lista congelou. finished_at: type: string format: date-time nullable: true canceled_at: type: string format: date-time nullable: true summary: $ref: '#/components/schemas/CampaignSummary' stats: $ref: '#/components/schemas/MailStats' created_at: type: string format: date-time updated_at: type: string format: date-time ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string CampaignStatus: type: string enum: - draft - scheduled - sending - paused - sent - canceled MailBlock: type: object description: > Um bloco do corpo do e-mail. A lista de tipos é FECHADA e quem escreve o HTML é a API — o club manda só o conteúdo de cada bloco. `text` é o título, o parágrafo (com `**negrito**`, `*itálico*`, `[link](https://…)` e quebra de linha) ou o rótulo do botão; variáveis entram como `{{name}}` ou `{{first_name|valor quando vazio}}` e saem sempre escapadas, nunca como marcação. `url` é o destino do botão (ou o link da imagem): `https://`, `http://`, `mailto:` ou `{{classroom_url}}/caminho`. A imagem é uma mídia PÚBLICA e pronta da biblioteca — a URL assinada de uma privada venceria dentro da caixa de entrada. required: - kind properties: kind: $ref: '#/components/schemas/MailBlockKind' text: type: string maxLength: 5000 level: type: integer enum: - 1 - 2 url: type: string maxLength: 2000 media_id: type: string format: uuid alt: type: string maxLength: 200 CampaignAudience: type: object description: > Quem recebe. Sem nenhuma regra de inclusão, é o club inteiro; com regras, é quem casa com QUALQUER uma delas. A exclusão tira quem casa com qualquer regra dela. Um id que deixou de existir não casa com ninguém — a audiência nunca se alarga sozinha. properties: include: $ref: '#/components/schemas/AudienceRules' exclude: $ref: '#/components/schemas/AudienceRules' CampaignSummary: type: object required: - recipients - sent - opened - clicked properties: recipients: type: integer sent: type: integer opened: type: integer clicked: type: integer MailStats: type: object description: > Os números do envio, contados na leitura. `sent` é o que o provedor aceitou; `suppressed` e `unreachable` não saíram (recusou os e-mails do club, ou a conta foi removida / nunca confirmou o endereço). Os engajamentos contam PESSOAS, não batidas: abrir dez vezes é uma abertura. required: - total - pending - sending - sent - failed - suppressed - unreachable - canceled - delivered - bounced - complained - opened - clicked properties: total: type: integer pending: type: integer sending: type: integer sent: type: integer failed: type: integer suppressed: type: integer unreachable: type: integer canceled: type: integer delivered: type: integer bounced: type: integer complained: type: integer opened: type: integer clicked: type: integer MailBlockKind: type: string enum: - heading - paragraph - button - image - divider AudienceRules: type: object description: | Cada lista é "qualquer um destes". `delivery_ids` e `cohort_ids` pedem matrícula ATIVA; `product_ids`, compra paga e não reembolsada; `completed_course_ids`, todas as aulas publicadas do curso concluídas. properties: delivery_ids: type: array maxItems: 50 items: type: string format: uuid cohort_ids: type: array maxItems: 50 items: type: string format: uuid product_ids: type: array maxItems: 50 items: type: string format: uuid completed_course_ids: type: array maxItems: 50 items: type: string format: uuid responses: Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' NotFound: description: Recurso não encontrado content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Conflict: description: >- Conflito com o estado atual. O `code` diz qual; a descrição da operação lista os possíveis. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' TooManyRequests: description: Teto por IP atingido headers: Retry-After: schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | Token OPACO de sessão de quem administra, emitido por `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo desenho do `studentSession`, para a outra identidade. É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o `studentSession`; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe. O dashboard o guarda em cookie httpOnly, que o BFF troca pelo `Authorization` a cada chamada. ```` ## Related topics - [Campanhas e automações](/essentials/campaigns-and-workflows.md) - [Pausar automação](/api-reference/workflows/pause.md) - [Campanha](/api-reference/campaigns/get.md) - [Campanhas](/api-reference/campaigns/list.md) - [Alterar campanha](/api-reference/campaigns/update.md)