Skip to content
Coritan Docs

Organization API: Organizations & Members: Email log

The 2 Organization API operations for email log.

View as Markdown

Part of Organizations & Members.

Operations

Section titled Operations
Method Path Summary
GET /api/v1/orgs/{org_slug}/email-log/settings Whether the organization's template emails are tracked for opens and clicks
PUT /api/v1/orgs/{org_slug}/email-log/settings Turn open and click tracking of the organization's template emails on or off

Whether the organization's template emails are tracked for opens and clicks

Section titled Whether the organization's template emails are tracked for opens and clicks

GET /api/v1/orgs/{org_slug}/email-log/settings

Whether the organization's template emails are tracked for opens and clicks. enabled is the organization's own choice (on unless it turned tracking off), platform_enabled is whether Coritan tracking is on at all, and tracked is both. Security emails (sign-in, password and verification) are never tracked. Needs Tier 3 support or above.

Parameters

Section titled Parameters
Name In Type Required
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Turn open and click tracking of the organization's template emails on or off

Section titled Turn open and click tracking of the organization's template emails on or off

PUT /api/v1/orgs/{org_slug}/email-log/settings

Turn open and click tracking of the organization's template emails on or off. From then on a new email carries no tracking pixel and its links go straight to their pages; emails already sent keep what they recorded. Needs the owner or an admin.

Parameters

Section titled Parameters
Name In Type Required
org_slug path string yes

Request body

Section titled Request body

application/json (required)

Field Type Required
enabled boolean yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.