Skip to main content
POST
cURL

Authorizations

X-Api-Key
string
header
required

Your Jobo API key. Create one in the dashboard under Developers → API Keys. Live keys start with jbe_live_ and sandbox keys with jbe_test_.

Body

application/json
provider
enum<string>
required

imap connects with a host and credentials; outlook starts the hosted Microsoft OAuth consent flow.

Available options:
imap,
outlook
address
string<email>
required

The mailbox address. Unique per account; lowercased.

imap_host
string | null

Required when provider is imap. The IMAP port must be 993 or 143.

imap_port
integer | null
default:993
imap_security
enum<string> | null
default:ssl
Available options:
ssl,
starttls
username
string | null

Defaults to address.

password
string | null

Required for provider imap (use an app password where the provider offers them). Encrypted at rest, never returned.

Response

The mailbox. Status connected for a verified imap mailbox; status pending with authorization_url for an outlook mailbox awaiting consent.

api_version
enum<string>
required

Version of the Auto Apply API contract.

Available options:
2026-08-31
Example:

"2026-08-31"

id
string<uuid>
required
provider
enum<string>
required
Available options:
imap,
outlook
address
string<email>
required
status
enum<string>
required
  • pending: an outlook mailbox awaiting consent.
  • connected: the last connectivity check succeeded.
  • error: the last connectivity check failed; see last_error.
Available options:
pending,
connected,
error
created_at
string<date-time>
required
updated_at
string<date-time>
required
imap_host
string | null
imap_port
integer | null
imap_security
string | null
username
string | null
authorization_url
string<uri> | null

Only on a pending outlook mailbox: open this URL (or send it to the mailbox owner) to grant consent via Microsoft.

last_error
string | null
connected_at
string<date-time> | null
last_checked_at
string<date-time> | null