PT EN

Pedidos de contacto

URL base: $PUBLIC_API

O objecto

idstring · obrigatório

Contact request identifier

statusstring · obrigatório

Always new for a fresh request

um de new

created_atstring (date-time) · obrigatório

When the request was received

O objecto
{
  "id": "pub_2N9GuTbc4N3Cen3kov12WlDEOBh",
  "status": "new",
  "created_at": "2026-11-19T09:30:00Z"
}

Enviar um pedido de contacto

Registos

POST /contact-requests

Stores a contact form submission for the platform team and notifies them. topic, name (up to 120 characters), organization (up to 160), email (up to 254, a plain address) and message (up to 2000) are required; phone is up to 40 characters, connections must not be negative, and locale is pt (default) or en. The body is at most 4096 bytes (413 PAYLOAD_TOO_LARGE). When the installation enables the bot challenge, an anonymous UI request must carry challenge_token (scope intake.contact): a missing token returns 403 CHALLENGE_REQUIRED and a rejected one 403 CHALLENGE_FAILED; a signed-in caller skips the challenge. At most 5 requests per IP address and 3 per e-mail address are accepted per hour; beyond that the response is 429 RATE_LIMITED with Retry-After. A request whose hidden website field is filled is answered 201 but not stored.

Corpo application/json

topicstring · obrigatório

What the request is about (case-insensitive)

um de sales, support, partnership, press, security

namestring · obrigatório

Your name

organizationstring · obrigatório

Organization you represent

emailstring (email) · obrigatório

Reply address

phonestring · opcional

Optional phone number

connectionsinteger · opcional

Optional number of service connections your organization runs

messagestring · obrigatório

Your message

localestring · opcional · predefinição pt

Language to reply in

um de pt, en

websitestring · opcional

Leave empty. Hidden form field; a filled value marks the request as automated and it is not stored

challenge_tokenstring · opcional

Bot-challenge token when the challenge is enabled (anonymous callers). Only UI requests (browser headers, the dashboard, or X-Client mobile or desktop) are challenged; API requests never are.

Devolve

201 Contact request received

Mostrar atributos
idstring · obrigatório

Contact request identifier

statusstring · obrigatório

Always new for a fresh request

um de new

created_atstring (date-time) · obrigatório

When the request was received

Erros 400 · 403 · 413 · 429

curl -X POST "$PUBLIC_API/contact-requests" \
  -H "Content-Type: application/json" \
  -d '{
  "topic": "sales",
  "name": "Ana Matsinhe",
  "organization": "organization",
  "email": "ana.matsinhe@example.org",
  "phone": "+258841234567",
  "connections": 0,
  "message": "Leitura confirmada no local.",
  "locale": "pt",
  "website": "website",
  "challenge_token": "challenge token"
}'
Resposta 201
{
  "id": "pub_2N9GuTbc4N3Cen3kov12WlDEOBh",
  "status": "new",
  "created_at": "2026-11-19T09:30:00Z"
}