Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: JNexum Growth API
version: 0.2.0
tags:
- name: Growth
paths:
/growth/descadastro:
get:
summary: Growth Descadastro
description: 'Página de confirmação do descadastro de campanhas de growth (spec item
7). Só LÊ: não altera nada. Scanners de e-mail e pré-visualizadores abrem
todo link de uma mensagem por GET, e quando o GET descadastrava, isso
suprimia o lead sem que ele tivesse clicado (e sem aviso). Quem de fato
descadastra é o POST abaixo, acionado pelo botão desta página ou pelo
descadastro de um clique do cliente de e-mail (List-Unsubscribe-Post).'
operationId: growth_descadastro_growth_descadastro_get
parameters:
- name: email
in: query
required: true
schema:
type: string
title: Email
- name: token
in: query
required: true
schema:
type: string
title: Token
responses:
'200':
description: Successful Response
content:
text/html:
schema:
type: string
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Growth
post:
summary: Growth Descadastro Confirmar
description: 'Efetiva o descadastro. Cobre leads (`contatos`) e usuários cadastrados
(`usuarios`): o link não sabe de antemão qual é o caso, e
`growth.db.marcar_descadastro` atualiza as duas tabelas. Aceita o POST de
um clique do RFC 8058 (corpo `List-Unsubscribe=One-Click`, e-mail e token
na query string do link do cabeçalho). O corpo não é lido: a autoridade é
só o token HMAC, e o handler é síncrono no banco, então roda em thread
para não parar o event loop.'
operationId: growth_descadastro_confirmar_growth_descadastro_post
parameters:
- name: email
in: query
required: true
schema:
type: string
title: Email
- name: token
in: query
required: true
schema:
type: string
title: Token
responses:
'200':
description: Successful Response
content:
text/html:
schema:
type: string
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Growth
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError