Praecise Platform
Menu

Praecise account/ Reference/ Mailboxes

Make a mailbox on a verified domain

post/api/mailboxes

The mailbox reads with the Praecise account; it has no password of its own.

Before you call

Credential
Authorization: Bearer $KEY
Credential
Authorization: Bearer $KEY

Request bodyapplication/json, required

  • localpartstringrequired
    The part before the @.
  • domainstringrequired
  • namestring
    Shown as the sender. The local part when left out.
  • kindstring
    What holds the address: a person, an agent, or a machine. One of: human, agent, machine. Default: human.

Responses

  • 201application/json
    Made.
    • emailstring (email)required
    • namestring or null
    • kindstringrequired
      What holds the address: a person, an agent, or a machine. One of: human, agent, machine. Default: human.
    • inboxbooleanrequired
      False for a send-only address.
  • 400application/json
    The local part is not usable, or kind is not one of the three.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring
  • 401application/json
    Neither a service token nor a signed-in session was accepted.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring
  • 404application/json
    That domain is not on this account.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring
  • 409application/json
    That domain is not verified yet.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring
  • 502application/json
    The mail service could not be reached, or refused.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring
  • 503application/json
    Mail is not configured on this deployment.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring

This page as Markdown