Skip to main content
POST

Autorizações

Authorization
string
header
obrigatório

Authorization: Bearer sk_live_xxxxx

Cabeçalhos

Idempotency-Key
string

Chave única para evitar envio duplicado.

x-idempotency-key
string

Corpo

application/json

Envio canônico: to (device IDs, 1–500) e conteúdo em payload.

to
string[]
obrigatório

IDs de dispositivos push registrados.

Required array length: 1 - 500 elements
type
enum<string>
padrão:push
obrigatório

push (conteúdo livre em payload) ou template (payload.templateId).

Opções disponíveis:
push,
template
payload
object
obrigatório

Conteúdo conforme type. push: pelo menos title ou body. template: templateId obrigatório.

from
string
obrigatório

App de push: id ou nome.

schedule
object
options
object
metadata
object

Metadados em PushLog.metadata (string→string).

pushTargetLocale
string

Locale alvo para tradução por destinatário (opcional).

localization
object
i18n
object

Traduções manuais por locale (ex.: {"en": {"title": "Hi", "body": "…"}}).

Resposta

Resposta em cache (idempotency): mesma resposta do 202 da primeira chamada.

success
boolean
obrigatório
Exemplo:

true

data
object
obrigatório