mail

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

Create a mailbox.

모든 mail 엔드포인트

모든 개발자 문서 →

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 mail.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요

상세 정보

Creates local@domain and returns it with its password, once. The password is never stored and cannot be read back — a lost one is replaced by resetMailboxPassword, not recovered. password is null when the backend reconciled to a mailbox that already existed and refused to rotate a live password; show that as "we could not display a password", never as a blank one. Requires mail.manage. Fails 409 on a duplicate address, and 422 when the service is not live yet or the domain is at its mailbox ceiling.

매개변수

이름	유형	필수	설명
`mailServiceId (path)`	`Uuid`	예	Email service ID (UUIDv7).

요청 본문

이름	유형	필수	설명
`local`	`string`	예	The part before the `@`.
`send`	`boolean`	아니요	—
`receive`	`boolean`	아니요	—

응답

이름	유형	필수	설명
`mailbox`	`Mailbox`	예	One mailbox. Never carries a password — see `MailboxCreated`.
`password`	`object`	예	The password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 404 · 409 · 422 · 429 · 503

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

인증