Messaging Settings API

Base URL: https://email-settings.sls.epilot.io
API Docs: https://docs.epilot.io/api/email-settings

The Messaging Settings API provides comprehensive management of email configurations for epilot organizations.

Quick Start

# List available operations
epilot email-settings

# Call an operation
epilot email-settings provisionEpilotEmailAddress

Common Flags

Flag	Description
`-p key=value`	Set a named parameter
`-d '{...}'`	Request body JSON
`-H 'Key: Value'`	Custom header
`-t, --token <token>`	Bearer token for authentication
`--profile <name>`	Use a named profile
`-s, --server <url>`	Override server base URL
`-i, --include`	Include response headers in output
`--json`	Output raw JSON (no formatting)
`-v, --verbose`	Verbose output (show request details)
`--jsonata <expr>`	JSONata expression to transform response
`--definition <file>`	Override OpenAPI spec file/URL
`--guided`	Prompt for all parameters interactively
`--no-interactive`	Disable interactive prompts

Operations

Email addresses

provisionEpilotEmailAddress — Provisions or reactivates an epilot-managed email address for the organization.
setEmailAddressPrimary — Sets the specified email address as the primary address for the organization.
getEmailAddress — Retrieves the details of a specific email address by its ID.
updateEmailAddress — Updates the configuration of an existing email address.
deleteEmailAddress — Permanently deletes an email address from the organization.
listEmailAddresses — Retrieves all email addresses configured for the organization.
addEmailAddress — Adds a new email address to the organization.

Shared inboxes

getSharedInbox — Retrieves the details of a specific shared inbox by its ID.
updateSharedInbox — Updates the configuration of an existing shared inbox.
deleteSharedInbox — Deletes a shared inbox and reroutes all associated emails to a successor inbox.
listSharedInboxes — Retrieves all shared inboxes configured for the organization.
addSharedInbox — Creates a new shared inbox for the organization.

Inbox buckets

listInboxBuckets — Retrieves all inbox buckets for the organization.

O365 Outlook Connection

connectOutlook — Returns Microsoft authorization URL for Outlook OAuth.
getOutlookConnectionStatus — Returns all Microsoft 365 / Outlook connections for the organization.
disconnectOutlook — Removes the Microsoft 365 / Outlook connection for a specific tenant.
connectOutlookMailbox — Connects an Outlook mailbox:
disconnectOutlookMailbox — Disconnects a single Outlook mailbox by email address.
startMailboxSync — Triggers an Outlook mailbox sync for the specified email address.
getMailboxSyncStatus — Returns the current or latest sync status for the specified mailbox.
retryMailboxSync — Retries failed messages from a previous sync execution.
getConnectedOutlookEmails — Returns all Outlook email addresses connected to the organization.
outlookOAuthCallback — Exchanges authorization code for tokens and stores them.

Settings

getSettings — Retrieves settings of a specific type for the organization.
addSetting — Creates a new setting of the specified type.
deleteSetting — Deletes a setting by its ID and type.
updateSetting — Updates an existing setting identified by its ID.

Domains

addDomain — Adds a custom email domain to the organization.
deleteDomain — Removes a custom email domain from the organization.
verifyNameServers — Verifies that the domain's name server (NS) records are correctly configured.
verifyDomain — Verifies ownership and configuration of a custom email domain.

`provisionEpilotEmailAddress`

Provisions or reactivates an epilot-managed email address for the organization.

PUT /v2/email-settings/email-addresses/epilot:provision

Request Body (required)

Sample Call

epilot email-settings provisionEpilotEmailAddress \
  -d '{"address":"mycompany@epilot.cloud"}'

Using stdin pipe:

cat body.json | epilot email-settings provisionEpilotEmailAddress

With JSONata filter:

epilot email-settings provisionEpilotEmailAddress --jsonata '$'

Sample Response

{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456",
  "address": "sales@yourcompany.com",
  "name": "Sales Team",
  "user_ids": ["user-123", "user-456"],
  "group_ids": ["group-789"],
  "default_signature_id": "sig-abc",
  "shared_inbox_id": "inbox-xyz",
  "is_active": true,
  "is_primary": false,
  "is_epilot_email_address": false
}

`setEmailAddressPrimary`

Sets the specified email address as the primary address for the organization.

POST /v2/email-settings/email-addresses/primary

Request Body (required)

Sample Call

epilot email-settings setEmailAddressPrimary \
  -d '{"address":"sales@yourcompany.com"}'

Using stdin pipe:

cat body.json | epilot email-settings setEmailAddressPrimary

With JSONata filter:

epilot email-settings setEmailAddressPrimary --jsonata '$'

Sample Response

{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456",
  "address": "sales@yourcompany.com",
  "name": "Sales Team",
  "user_ids": ["user-123", "user-456"],
  "group_ids": ["group-789"],
  "default_signature_id": "sig-abc",
  "shared_inbox_id": "inbox-xyz",
  "is_active": true,
  "is_primary": false,
  "is_epilot_email_address": false
}

`getEmailAddress`

Retrieves the details of a specific email address by its ID.

GET /v2/email-settings/email-addresses/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Unique identifier of the email address. This can be either the UUID assigned

when the email address was created, or the email address string itself. |

Sample Call

epilot email-settings getEmailAddress \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot email-settings getEmailAddress 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot email-settings getEmailAddress -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456",
  "address": "sales@yourcompany.com",
  "name": "Sales Team",
  "user_ids": ["user-123", "user-456"],
  "group_ids": ["group-789"],
  "default_signature_id": "sig-abc",
  "shared_inbox_id": "inbox-xyz",
  "is_active": true,
  "is_primary": false,
  "is_epilot_email_address": false
}

`updateEmailAddress`

Updates the configuration of an existing email address.

PUT /v2/email-settings/email-addresses/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Unique identifier of the email address. This can be either the UUID assigned

when the email address was created, or the email address string itself. |

Request Body

Sample Call

epilot email-settings updateEmailAddress \
  -p id=123e4567-e89b-12d3-a456-426614174000

With request body:

epilot email-settings updateEmailAddress \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -d '{
  "name": "Sales Team",
  "user_ids": ["user-123", "user-456"],
  "group_ids": ["group-789"],
  "default_signature_id": "sig-abc",
  "shared_inbox_id": "inbox-xyz",
  "is_active": true
}'

Using positional args for path parameters:

epilot email-settings updateEmailAddress 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot email-settings updateEmailAddress -p id=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot email-settings updateEmailAddress -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456",
  "address": "sales@yourcompany.com",
  "name": "Sales Team",
  "user_ids": ["user-123", "user-456"],
  "group_ids": ["group-789"],
  "default_signature_id": "sig-abc",
  "shared_inbox_id": "inbox-xyz",
  "is_active": true,
  "is_primary": false,
  "is_epilot_email_address": false
}

`deleteEmailAddress`

Permanently deletes an email address from the organization.

DELETE /v2/email-settings/email-addresses/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Unique identifier of the email address. This can be either the UUID assigned

when the email address was created, or the email address string itself. |

Sample Call

epilot email-settings deleteEmailAddress \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot email-settings deleteEmailAddress 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot email-settings deleteEmailAddress -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

`listEmailAddresses`

Retrieves all email addresses configured for the organization.

GET /v2/email-settings/email-addresses

Sample Call

epilot email-settings listEmailAddresses

With JSONata filter:

epilot email-settings listEmailAddresses --jsonata '$'

Sample Response

[
  {
    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "created_by": "user-123",
    "updated_by": "user-456",
    "address": "sales@yourcompany.com",
    "name": "Sales Team",
    "user_ids": ["user-123", "user-456"],
    "group_ids": ["group-789"],
    "default_signature_id": "sig-abc",
    "shared_inbox_id": "inbox-xyz",
    "is_active": true,
    "is_primary": false,
    "is_epilot_email_address": false
  }
]

`addEmailAddress`

Adds a new email address to the organization.

POST /v2/email-settings/email-addresses

Request Body (required)

Sample Call

epilot email-settings addEmailAddress

With request body:

epilot email-settings addEmailAddress \
  -d '{
  "address": "support@yourcompany.com",
  "name": "Customer Support",
  "user_ids": ["user-123"],
  "group_ids": ["group-456"],
  "default_signature_id": "sig-789",
  "shared_inbox_id": "inbox-abc"
}'

Using stdin pipe:

cat body.json | epilot email-settings addEmailAddress

With JSONata filter:

epilot email-settings addEmailAddress --jsonata '$'

Sample Response

{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456",
  "address": "sales@yourcompany.com",
  "name": "Sales Team",
  "user_ids": ["user-123", "user-456"],
  "group_ids": ["group-789"],
  "default_signature_id": "sig-abc",
  "shared_inbox_id": "inbox-xyz",
  "is_active": true,
  "is_primary": false,
  "is_epilot_email_address": false
}

`getSharedInbox`

Retrieves the details of a specific shared inbox by its ID.

GET /v2/email-settings/shared-inboxes/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Unique identifier (UUID) of the shared inbox.

Use default to reference the organization's default inbox. |

Sample Call

epilot email-settings getSharedInbox \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot email-settings getSharedInbox 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot email-settings getSharedInbox -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456",
  "name": "Customer Support",
  "color": "#4CAF50",
  "assignees": ["user-123", "user-456"],
  "description": "Incoming customer support requests",
  "bucket_id": "bucket-xyz"
}

`updateSharedInbox`

Updates the configuration of an existing shared inbox.

PUT /v2/email-settings/shared-inboxes/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Unique identifier (UUID) of the shared inbox.

Use default to reference the organization's default inbox. |

Request Body

Sample Call

epilot email-settings updateSharedInbox \
  -p id=123e4567-e89b-12d3-a456-426614174000

With request body:

epilot email-settings updateSharedInbox \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -d '{
  "color": "#4CAF50",
  "name": "Customer Support",
  "assignees": ["user-123", "user-456"],
  "description": "Incoming customer support requests"
}'

Using positional args for path parameters:

epilot email-settings updateSharedInbox 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot email-settings updateSharedInbox -p id=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot email-settings updateSharedInbox -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456",
  "name": "Customer Support",
  "color": "#4CAF50",
  "assignees": ["user-123", "user-456"],
  "description": "Incoming customer support requests",
  "bucket_id": "bucket-xyz"
}

`deleteSharedInbox`

Deletes a shared inbox and reroutes all associated emails to a successor inbox.

DELETE /v2/email-settings/shared-inboxes/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Unique identifier (UUID) of the shared inbox.

Sample Call

epilot email-settings deleteSharedInbox \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot email-settings deleteSharedInbox 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot email-settings deleteSharedInbox -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

`listSharedInboxes`

Retrieves all shared inboxes configured for the organization.

GET /v2/email-settings/shared-inboxes

Sample Call

epilot email-settings listSharedInboxes

With JSONata filter:

epilot email-settings listSharedInboxes --jsonata '$'

Sample Response

[
  {
    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "created_by": "user-123",
    "updated_by": "user-456",
    "name": "Customer Support",
    "color": "#4CAF50",
    "assignees": ["user-123", "user-456"],
    "description": "Incoming customer support requests",
    "bucket_id": "bucket-xyz"
  }
]

`addSharedInbox`

Creates a new shared inbox for the organization.

POST /v2/email-settings/shared-inboxes

Request Body (required)

Sample Call

epilot email-settings addSharedInbox

With request body:

epilot email-settings addSharedInbox \
  -d '{
  "id": "support-inbox",
  "color": "#2196F3",
  "name": "Sales Inquiries",
  "assignees": ["user-123", "user-456"],
  "description": "Inbound sales and pricing requests"
}'

Using stdin pipe:

cat body.json | epilot email-settings addSharedInbox

With JSONata filter:

epilot email-settings addSharedInbox --jsonata '$'

Sample Response

{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456",
  "name": "Customer Support",
  "color": "#4CAF50",
  "assignees": ["user-123", "user-456"],
  "description": "Incoming customer support requests",
  "bucket_id": "bucket-xyz"
}

`listInboxBuckets`

Retrieves all inbox buckets for the organization.

GET /v2/email-settings/inbox-buckets

Sample Call

epilot email-settings listInboxBuckets

With JSONata filter:

epilot email-settings listInboxBuckets --jsonata '$'

Sample Response

[
  {
    "id": "bucket-abc",
    "inbox_id": "inbox-xyz"
  }
]

`connectOutlook`

Returns Microsoft authorization URL for Outlook OAuth.

GET /v2/outlook/connect

Sample Call

epilot email-settings connectOutlook

With JSONata filter:

epilot email-settings connectOutlook --jsonata 'authorization_url'

Sample Response

{
  "authorization_url": "string"
}

`getOutlookConnectionStatus`

Returns all Microsoft 365 / Outlook connections for the organization.

GET /v2/outlook/connection/status

Sample Call

epilot email-settings getOutlookConnectionStatus

With JSONata filter:

epilot email-settings getOutlookConnectionStatus --jsonata 'connections'

Sample Response

{
  "connections": [
    {
      "status": "connected",
      "action": "connect",
      "connected_by_display_name": "string",
      "connected_by_email": "user@example.com",
      "connected_by_user_id": "string",
      "connected_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z",
      "tenant_id": "string",
      "scopes": ["string"],
      "expires_at": "1970-01-01T00:00:00.000Z",
      "is_token_valid": true
    }
  ],
  "has_connections": true
}

`disconnectOutlook`

Removes the Microsoft 365 / Outlook connection for a specific tenant.

POST /v2/outlook/connection/disconnect

Request Body (required)

Sample Call

epilot email-settings disconnectOutlook \
  -d '{"tenant_id":"string"}'

Using stdin pipe:

cat body.json | epilot email-settings disconnectOutlook

With JSONata filter:

epilot email-settings disconnectOutlook --jsonata 'success'

Sample Response

{
  "success": true,
  "tenant_id": "string",
  "affected_shared_inboxes": ["string"]
}

`connectOutlookMailbox`

Connects an Outlook mailbox:

POST /v2/outlook/mailbox/connect

Request Body (required)

Sample Call

epilot email-settings connectOutlookMailbox \
  -d '{"email":"user@example.com","shared_inbox_id":"default","mailboxSyncTimeframe":"5m"}'

Using stdin pipe:

cat body.json | epilot email-settings connectOutlookMailbox

With JSONata filter:

epilot email-settings connectOutlookMailbox --jsonata 'email_address'

Sample Response

{
  "email_address": {
    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "created_by": "user-123",
    "updated_by": "user-456",
    "address": "sales@yourcompany.com",
    "name": "Sales Team",
    "user_ids": ["user-123", "user-456"],
    "group_ids": ["group-789"],
    "default_signature_id": "sig-abc",
    "shared_inbox_id": "inbox-xyz",
    "is_active": true,
    "is_primary": false,
    "is_epilot_email_address": false
  },
  "outlook_email": "user@example.com",
  "tenant_id": "string",
  "provider": "outlook"
}

`disconnectOutlookMailbox`

Disconnects a single Outlook mailbox by email address.

POST /v2/outlook/mailbox/{email}/disconnect

Parameters

Name	In	Type	Required	Description
`email`	path	string (email)	Yes	Email address of the Outlook mailbox to disconnect

Sample Call

epilot email-settings disconnectOutlookMailbox \
  -p email=user@example.com

Using positional args for path parameters:

epilot email-settings disconnectOutlookMailbox user@example.com

With JSONata filter:

epilot email-settings disconnectOutlookMailbox -p email=user@example.com --jsonata 'email'

Sample Response

{
  "success": true,
  "email": "user@example.com"
}

`startMailboxSync`

Triggers an Outlook mailbox sync for the specified email address.

POST /v2/outlook/mailbox/{email}/sync

Parameters

Name	In	Type	Required	Description
`email`	path	string (email)	Yes	Email address of the Outlook mailbox to sync

Request Body (required)

Sample Call

epilot email-settings startMailboxSync \
  -p email=user@example.com \
  -d '{"timeframe":"5m"}'

Using positional args for path parameters:

epilot email-settings startMailboxSync user@example.com

Using stdin pipe:

cat body.json | epilot email-settings startMailboxSync -p email=user@example.com

With JSONata filter:

epilot email-settings startMailboxSync -p email=user@example.com --jsonata '$'

`getMailboxSyncStatus`

Returns the current or latest sync status for the specified mailbox.

GET /v2/outlook/mailbox/{email}/sync/status

Parameters

Name	In	Type	Required	Description
`email`	path	string (email)	Yes	Email address of the Outlook mailbox

Sample Call

epilot email-settings getMailboxSyncStatus \
  -p email=user@example.com

Using positional args for path parameters:

epilot email-settings getMailboxSyncStatus user@example.com

With JSONata filter:

epilot email-settings getMailboxSyncStatus -p email=user@example.com --jsonata 'execution_id'

Sample Response

{
  "execution_id": "string",
  "status": "RUNNING",
  "timeframe": "5m",
  "started_at": "1970-01-01T00:00:00.000Z",
  "completed_at": "1970-01-01T00:00:00.000Z",
  "inbox": {
    "status": "PENDING",
    "total_messages": 0,
    "processed_messages": 0,
    "failed_messages": 0
  },
  "sent_items": {
    "status": "PENDING",
    "total_messages": 0,
    "processed_messages": 0,
    "failed_messages": 0
  }
}

`retryMailboxSync`

Retries failed messages from a previous sync execution.

POST /v2/outlook/mailbox/{email}/sync/retry

Parameters

Name	In	Type	Required	Description
`email`	path	string (email)	Yes	Email address of the Outlook mailbox

Request Body (required)

Sample Call

epilot email-settings retryMailboxSync \
  -p email=user@example.com \
  -d '{"sync_id":"string","scope":"all_failed","message_ids":["string"]}'

Using positional args for path parameters:

epilot email-settings retryMailboxSync user@example.com

Using stdin pipe:

cat body.json | epilot email-settings retryMailboxSync -p email=user@example.com

With JSONata filter:

epilot email-settings retryMailboxSync -p email=user@example.com --jsonata '$'

`getConnectedOutlookEmails`

Returns all Outlook email addresses connected to the organization.

GET /v2/outlook/mailbox/mappings

Sample Call

epilot email-settings getConnectedOutlookEmails

With JSONata filter:

epilot email-settings getConnectedOutlookEmails --jsonata 'outlook_emails'

Sample Response

{
  "outlook_emails": [
    {
      "outlook_email": "user@example.com",
      "tenant_id": "string",
      "provider": "outlook",
      "connected_at": "1970-01-01T00:00:00.000Z",
      "connected_by_user_id": "string"
    }
  ],
  "count": 0
}

`outlookOAuthCallback`

Exchanges authorization code for tokens and stores them.

GET /v2/outlook/oauth/callback

Parameters

Name	In	Type	Required
`code`	query	string	No
`state`	query	string	Yes
`session_state`	query	string	No
`error`	query	string	No
`error_description`	query	string	No
`error_subcode`	query	string	No
`client_info`	query	string	No
`error_uri`	query	string	No
`admin_consent`	query	string	No
`tenant`	query	string	No

Sample Call

epilot email-settings outlookOAuthCallback \
  -p state=example

With JSONata filter:

epilot email-settings outlookOAuthCallback -p state=example --jsonata 'connected'

Sample Response

{
  "connected": true,
  "expires_at": "1970-01-01T00:00:00.000Z",
  "scope": "string"
}

`getSettings`

Retrieves settings of a specific type for the organization.

GET /v1/email-settings

Parameters

Name	In	Type	Required	Description
`type`	query	"signature" \| "email_domain" \| "email_address" \| "whitelist_email_address" \| "restrict_duplicates_within"	Yes	The type of settings to retrieve. Determines which category of

Sample Call

epilot email-settings getSettings \
  -p type=signature

With JSONata filter:

epilot email-settings getSettings -p type=signature --jsonata '$'

Sample Response

[
  {
    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
    "name": "Default Signature",
    "org_id": "org-123",
    "type": "signature",
    "value": "Best regards, The Team",
    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "created_by": "user-123",
    "updated_by": "user-456"
  }
]

`addSetting`

Creates a new setting of the specified type.

POST /v1/email-settings

Request Body (required)

Sample Call

epilot email-settings addSetting

With request body:

epilot email-settings addSetting \
  -d '{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "name": "Default Signature",
  "org_id": "org-123",
  "type": "signature",
  "value": "Best regards, The Team",
  "html": "<p>Best regards,<br/><strong>The Team</strong></p>",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456"
}'

Using stdin pipe:

cat body.json | epilot email-settings addSetting

With JSONata filter:

epilot email-settings addSetting --jsonata '$'

Sample Response

[
  {
    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
    "name": "Default Signature",
    "org_id": "org-123",
    "type": "signature",
    "value": "Best regards, The Team",
    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "created_by": "user-123",
    "updated_by": "user-456"
  }
]

`deleteSetting`

Deletes a setting by its ID and type.

DELETE /v1/email-settings

Request Body (required)

Sample Call

epilot email-settings deleteSetting \
  -d '{"type":"signature","id":"a10bd0ff-4391-4cfc-88ee-b19d718a9bf7"}'

Using stdin pipe:

cat body.json | epilot email-settings deleteSetting

With JSONata filter:

epilot email-settings deleteSetting --jsonata 'id'

Sample Response

{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "name": "Default Signature",
  "org_id": "org-123",
  "type": "signature",
  "value": "Best regards, The Team",
  "html": "<p>Best regards,<br/><strong>The Team</strong></p>",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456"
}

`updateSetting`

Updates an existing setting identified by its ID.

POST /v1/email-settings/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	The unique identifier of the setting to update

Request Body (required)

Sample Call

epilot email-settings updateSetting \
  -p id=a10bd0ff-4391-4cfc-88ee-b19d718a9bf7

With request body:

epilot email-settings updateSetting \
  -p id=a10bd0ff-4391-4cfc-88ee-b19d718a9bf7 \
  -d '{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "name": "Default Signature",
  "org_id": "org-123",
  "type": "signature",
  "value": "Best regards, The Team",
  "html": "<p>Best regards,<br/><strong>The Team</strong></p>",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456"
}'

Using positional args for path parameters:

epilot email-settings updateSetting a10bd0ff-4391-4cfc-88ee-b19d718a9bf7

Using stdin pipe:

cat body.json | epilot email-settings updateSetting -p id=a10bd0ff-4391-4cfc-88ee-b19d718a9bf7

With JSONata filter:

epilot email-settings updateSetting -p id=a10bd0ff-4391-4cfc-88ee-b19d718a9bf7 --jsonata 'id'

Sample Response

{
  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
  "name": "Default Signature",
  "org_id": "org-123",
  "type": "signature",
  "value": "Best regards, The Team",
  "html": "<p>Best regards,<br/><strong>The Team</strong></p>",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "created_by": "user-123",
  "updated_by": "user-456"
}

`addDomain`

Adds a custom email domain to the organization.

POST /v1/email-settings/domain

Request Body (required)

Sample Call

epilot email-settings addDomain \
  -d '{"domain":"mail.yourcompany.com"}'

Using stdin pipe:

cat body.json | epilot email-settings addDomain

With JSONata filter:

epilot email-settings addDomain --jsonata '$'

Sample Response

[
  {
    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
    "name": "Default Signature",
    "org_id": "org-123",
    "type": "signature",
    "value": "Best regards, The Team",
    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "created_by": "user-123",
    "updated_by": "user-456"
  }
]

`deleteDomain`

Removes a custom email domain from the organization.

DELETE /v1/email-settings/domain

Request Body (required)

Sample Call

epilot email-settings deleteDomain \
  -d '{"domain":"mail.yourcompany.com"}'

Using stdin pipe:

cat body.json | epilot email-settings deleteDomain

With JSONata filter:

epilot email-settings deleteDomain --jsonata '$'

`verifyNameServers`

Verifies that the domain's name server (NS) records are correctly configured.

POST /v1/email-settings/domain/name-servers:verify

Request Body (required)

Sample Call

epilot email-settings verifyNameServers \
  -d '{"domain":"mail.yourcompany.com"}'

Using stdin pipe:

cat body.json | epilot email-settings verifyNameServers

With JSONata filter:

epilot email-settings verifyNameServers --jsonata '$'

Sample Response

[
  {
    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
    "name": "Default Signature",
    "org_id": "org-123",
    "type": "signature",
    "value": "Best regards, The Team",
    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "created_by": "user-123",
    "updated_by": "user-456"
  }
]

`verifyDomain`

Verifies ownership and configuration of a custom email domain.

POST /v1/email-settings/domain:verify

Request Body (required)

Sample Call

epilot email-settings verifyDomain \
  -d '{"domain":"mail.yourcompany.com"}'

Using stdin pipe:

cat body.json | epilot email-settings verifyDomain

With JSONata filter:

epilot email-settings verifyDomain --jsonata '$'

Sample Response

[
  {
    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
    "name": "Default Signature",
    "org_id": "org-123",
    "type": "signature",
    "value": "Best regards, The Team",
    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "created_by": "user-123",
    "updated_by": "user-456"
  }
]

Messaging Settings API

Quick Start​

Common Flags​

Operations​

provisionEpilotEmailAddress​

setEmailAddressPrimary​

getEmailAddress​

updateEmailAddress​

deleteEmailAddress​

listEmailAddresses​

addEmailAddress​

getSharedInbox​

updateSharedInbox​

deleteSharedInbox​

listSharedInboxes​

addSharedInbox​

listInboxBuckets​

connectOutlook​

getOutlookConnectionStatus​

disconnectOutlook​

connectOutlookMailbox​

disconnectOutlookMailbox​

startMailboxSync​

getMailboxSyncStatus​

retryMailboxSync​

getConnectedOutlookEmails​

outlookOAuthCallback​

getSettings​

addSetting​

deleteSetting​

updateSetting​

addDomain​

deleteDomain​

verifyNameServers​

verifyDomain​

Quick Start

Common Flags

Operations

`provisionEpilotEmailAddress`

`setEmailAddressPrimary`

`getEmailAddress`

`updateEmailAddress`

`deleteEmailAddress`

`listEmailAddresses`

`addEmailAddress`

`getSharedInbox`

`updateSharedInbox`

`deleteSharedInbox`

`listSharedInboxes`

`addSharedInbox`

`listInboxBuckets`

`connectOutlook`

`getOutlookConnectionStatus`

`disconnectOutlook`

`connectOutlookMailbox`

`disconnectOutlookMailbox`

`startMailboxSync`

`getMailboxSyncStatus`

`retryMailboxSync`

`getConnectedOutlookEmails`

`outlookOAuthCallback`

`getSettings`

`addSetting`

`deleteSetting`

`updateSetting`

`addDomain`

`deleteDomain`

`verifyNameServers`

`verifyDomain`