Skip to main content
POST
Authenticate a mailbox

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Body

loginAddress
string
required
Required string length: 3 - 255
password
string
required
Required string length: 1 - 1024

Response

Response for status 200

credentialId
string
required
userId
string
required
loginAddress
string
required
type
string
required
Allowed value: "mailbox"
sendingMode
enum<string>
required
Available options:
identity,
scoped_domains
sendingName
string · null · null
required
sendingAddress
string · null · null
required
accessMode
enum<string>
required
Available options:
read,
read_write
scopes
object[]
required