Whether an address can be made now

Before you call

Credential

Authorization: Bearer $KEY

Scope

inbox:read

Graphql

Query.inboxMailboxAvailable

Sdk

inbox.mailbox.available

Cli

inbox mailbox available

Parameters

• localpartstringrequired
  In the query
• domainstring
  In the query

Responses

• 200application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring