Inscrever contato numa jornada

v1.0.0

POSThttps://api.staging.growthaisystem.com/api/v1/contacts/{id}/journeys

ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposcontacts.writeautomations.enroll

Põe o contato numa jornada ATIVA (sequência de e-mails e/ou WhatsApp da Growth AI Mail), com as mesmas regras da inscrição manual da tela de Jornadas: uma inscrição ativa por contato, quem se descadastrou nunca volta, reinscrição só se a jornada permitir. A jornada roda a versão publicada de hoje.

Escopos: contacts.write e automations.enroll. Funcionário digital: só as jornadas que o dono escolheu no cartão da ferramenta (403 journey_not_allowed nas outras).

Funcionário digital: o pedido fica SEMPRE para o dono aprovar (202, acompanhe em GET /actions/{id}); na aprovação as mesmas regras são conferidas de novo e, se algo mudou, nada sai.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

idstringobrigatório
- tamanho 1–80

Corpo da requisição

application/jsonobrigatório

V1ContactJourneyInputInput

journeyIdstringobrigatório
- tamanho 1–120

Respostas

12 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

A Idempotency-Key repetiu uma inscrição anterior: a mesma, com idempotency_replay: true.

V1ContactJourneyEnrollment

contactIdstring
journeyIdstring
journeyNamestring
enrollmentIdstring
enrolledAtstring
idempotency_replaytruepode faltar
- sempre true

Definição

POST/contacts/{id}/journeys

Exemplo

https://api.staging.growthaisystem.com/api/v1/contacts/SEU_ID_AQUI/journeys

Requisição

curl -X POST "https://api.staging.growthaisystem.com/api/v1/contacts/SEU_ID_AQUI/journeys" \
  -H "Authorization: Bearer gos_SEU_TOKEN_AQUI"

Isto chama a API de verdade. A requisição sai do seu navegador direto para https://api.staging.growthaisystem.com — dado real, do workspace da chave que você colar. Em escritas, o efeito é permanente.

Chave de APIBearerobrigatório

Vai no cabeçalho Authorization: Bearer …. Ela nunca aparece no cURL copiável nem sai desta aba.

Lembrar nesta aba — some ao fechá-la. Não marque em computador compartilhado: a chave dá acesso ao workspace inteiro dentro dos escopos dela.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

idtextoobrigatório

Corpoapplication/jsonobrigatório

JSON válido· 1 linha

O exemplo vem do próprio schema da API. Troque os valores pelos seus antes de enviar.

Vai sair assim

POSThttps://api.staging.growthaisystem.com/api/v1/contacts/{id}/journeys

O botão copia o cURL equivalente — com gos_SEU_TOKEN_AQUI no lugar da sua chave.

⌘Enter

Resposta

{
  "contactId": "<texto>",
  "journeyId": "<texto>",
  "journeyName": "<texto>",
  "enrollmentId": "<texto>",
  "enrolledAt": "<texto>",
  "idempotency_replay": true
}