mail

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

Set an auto-reply on a mailbox.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението mail.manage; ключ без него се отхвърля с 403, а не с 404.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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> }'

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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`.

Параметри

Име	Тип	Задължително	Какво представлява
`mailServiceId (path)`	`Uuid`	Да	Email service ID (UUIDv7).

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`local`	`string`	Да	The mailbox to auto-reply for.
`subject`	`string`	Не	—
`content`	`string`	Да	—
`start_time`	`string`	Не	RFC 3339. Omit or `null` for no schedule - see `MailResponder`.
`end_time`	`string`	Не	RFC 3339, and must be after `start_time` when both are given.

Отговор

Име	Тип	Задължително	Какво представлява
`id`	`string`	Да	The mail backend's identifier - the handle `DELETE` needs.
`local`	`string`	Да	The part before the `@`.
`address`	`string`	Да	The mailbox this replies for.
`subject`	`string`	Да	—
`content`	`string`	Да	The reply body.
`start_time`	`string`	Да	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`	Да	When the auto-reply stops. `null` to run until switched off.

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422 · 429 · 503

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