MailboxesOperation mailboxes.test

Test a mailbox connection

Test the SMTP and IMAP connection.

POST/api/v1/mailboxes/{id}/test

Scope write: Create and edit lists, research, sequences, campaigns, memory, signals and learning; queue jobs.

Parameters

Name	In	Description
`id`required	path	The record's id.

No body. Everything the call needs is in the path.

curl

curl -X POST "https://crm.ashwanth.dev/api/v1/mailboxes/{id}/test" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY"

CLI

sales-engine mailboxes test <id>

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape

{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Runs against this server, as the workspace behind the key.

API key

Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.

Path

idrequired

The record's id.

Body (JSON)

Request

POST /api/v1/mailboxes/%7Bid%7D/test

Fill the path first.