SalesOS

Email Tracking

Email open and click tracking

Send tracked email

POST
/v1/email-tracking/send

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Request Body

application/jsonRequired

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/email-tracking/send" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Process inbound webhook

POST
/v1/email-tracking/webhook/inbound

Request Body

application/jsonRequired

Query Parameters

api_keystring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/email-tracking/webhook/inbound?api_key=%3Cstring%3E" \
  -H "Idempotency-Key: <string>" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Webhook for email delivery status updates (opened, clicked, bounced)

POST
/v1/email-tracking/webhook/status

Request Body

application/jsonRequired

Query Parameters

api_keystring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/email-tracking/webhook/status?api_key=%3Cstring%3E" \
  -H "Idempotency-Key: <string>" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Get threads

GET
/v1/email-tracking/threads

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

curl -X GET "https://api.salesos.org/v1/email-tracking/threads" \
  -H "Authorization: Bearer <token>"

Get a specific thread with all messages

GET
/v1/email-tracking/threads/{id}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.salesos.org/v1/email-tracking/threads/<string>" \
  -H "Authorization: Bearer <token>"

Get threads awaiting response

GET
/v1/email-tracking/awaiting-response

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

curl -X GET "https://api.salesos.org/v1/email-tracking/awaiting-response" \
  -H "Authorization: Bearer <token>"

Get imap status

GET
/v1/email-tracking/imap/status

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

curl -X GET "https://api.salesos.org/v1/email-tracking/imap/status" \
  -H "Authorization: Bearer <token>"

Force an immediate IMAP poll for new emails

POST
/v1/email-tracking/imap/poll

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/email-tracking/imap/poll" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

List drafts

GET
/v1/email-tracking/drafts

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

statusstring
limitstring
curl -X GET "https://api.salesos.org/v1/email-tracking/drafts?status=%3Cstring%3E&limit=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Get a specific draft

GET
/v1/email-tracking/drafts/{draftId}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

draftIdRequiredstring
curl -X GET "https://api.salesos.org/v1/email-tracking/drafts/<string>" \
  -H "Authorization: Bearer <token>"

Update a draft (edit before sending)

PATCH
/v1/email-tracking/drafts/{draftId}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Request Body

application/jsonRequired

Path Parameters

draftIdRequiredstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X PATCH "https://api.salesos.org/v1/email-tracking/drafts/<string>" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Discard/reject a draft

DELETE
/v1/email-tracking/drafts/{draftId}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

draftIdRequiredstring
curl -X DELETE "https://api.salesos.org/v1/email-tracking/drafts/<string>" \
  -H "Authorization: Bearer <token>"

Send a draft

POST
/v1/email-tracking/drafts/{draftId}/send

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

draftIdRequiredstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/email-tracking/drafts/<string>/send" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Email Integrations

Email provider connections

Unified Communications

Aggregated communication timeline