mail

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

Set an auto-reply on a mailbox.

Բոլոր mail վերջնակետերը

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա mail.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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 վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը 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).

Հարցման մարմին

ԱնունՏեսակՊահանջվում էԻնչ է դա
localstringԱյոThe mailbox to auto-reply for.
subjectstringՈչ
contentstringԱյո
start_timestringՈչRFC 3339. Omit or `null` for no schedule - see `MailResponder`.
end_timestringՈչRFC 3339, and must be after `start_time` when both are given.

Պատասխան

ԱնունՏեսակՊահանջվում էԻնչ է դա
idstringԱյոThe mail backend's identifier - the handle `DELETE` needs.
localstringԱյոThe part before the `@`.
addressstringԱյոThe mailbox this replies for.
subjectstringԱյո
contentstringԱյոThe reply body.
start_timestringԱյո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_timestringԱյոWhen the auto-reply stops. `null` to run until switched off.

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 404 · 422 · 429 · 503