mail

POST `/v1/mail/services/{mailServiceId}/responders`

Set an auto-reply on a mailbox.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão mail.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/responders \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "local": <string>, "content": <string> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

Idempotent on `local`: re-posting for the same mailbox reconciles to the existing responder rather than creating a second one, which is the backend's own natural key. Requires `mail.manage`.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`mailServiceId (path)`	`Uuid`	Sim	Email service ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`local`	`string`	Sim	The mailbox to auto-reply for.
`subject`	`string`	Não	—
`content`	`string`	Sim	—
`start_time`	`string`	Não	RFC 3339. Omit or `null` for no schedule - see `MailResponder`.
`end_time`	`string`	Não	RFC 3339, and must be after `start_time` when both are given.

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Sim	The mail backend's identifier - the handle `DELETE` needs.
`local`	`string`	Sim	The part before the `@`.
`address`	`string`	Sim	The mailbox this replies for.
`subject`	`string`	Sim	—
`content`	`string`	Sim	The reply body.
`start_time`	`string`	Sim	When the auto-reply starts. `null` when unscheduled (it replies from now on). ⭐ This used to be declared "Opaque - do not parse, compare or render as a date" (#664), out of…
`end_time`	`string`	Sim	When the auto-reply stops. `null` to run until switched off.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429 · 503

POST /v1/mail/services/{mailServiceId}/responders