Project

Download schema

List all projects for the team

GET

https://api.lettermint.co/v1

/projects

Bearer

List all projects for the team › query Parameters

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

filter[search]

string

sort

string[]

Enum values:

name

-name

created_at

-created_at

Default: ["-created_at"]

List all projects for the team › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

List all projects for the team › Responses

200

Paginated set of ProjectListData

ProjectListData[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Create a new project

POST

https://api.lettermint.co/v1

/projects

Bearer

Create a new project › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Create a new project › Request Body

StoreProjectData

name

string · maxLength: 255 · required

smtp_enabled

boolean

Default: false

initial_routes

InitialRoutes · enum

Enum values:

both

transactional

broadcast

Default: both

short_token

boolean

Default: false

Create a new project › Responses

ProjectData · required

message

string · const · required

Const value: Project created successfully.

api_token

string · required

POST/projects

curl -X POST https://api.lettermint.co/v1/projects \
  -H "Authorization: Bearer $LETTERMINT_TEAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production App","initial_routes":"both"}'

Example Request Body

{
  "name": "name",
  "smtp_enabled": false,
  "initial_routes": "both",
  "short_token": false
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "smtp_enabled": true,
    "redact_email_content": true,
    "default_route_id": "default_route_id",
    "token_generated_at": "2024-08-25T15:00:00Z",
    "token_last_used_at": "2024-08-25T15:00:00Z",
    "token_last_used_ip": "token_last_used_ip",
    "routes": [
      {
        "id": "id",
        "project_id": "project_id",
        "slug": "slug",
        "name": "name",
        "route_type": "transactional",
        "is_default": true,
        "inbound_address": "inbound_address",
        "inbound_domain": "inbound_domain",
        "inbound_domain_verified_at": "2024-08-25T15:00:00Z",
        "inbound_spam_threshold": 0,
        "attachment_delivery": "inline",
        "settings": {},
        "webhooks_count": 0,
        "suppressed_recipients_count": 0,
        "statistics": {},
        "created_at": "2024-08-25T15:00:00Z",
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "routes_count": 0,
    "domains": [
      {
        "id": "id",
        "domain": "domain",
        "status_changed_at": "2024-08-25T15:00:00Z",
        "dns_records": [
          {
            "id": "id",
            "type": "TXT",
            "hostname": "hostname",
            "fqdn": "fqdn",
            "content": "content",
            "status": "active",
            "verified_at": "verified_at",
            "last_checked_at": "2024-08-25T15:00:00Z"
          }
        ],
        "projects": [
          {
            "id": "id",
            "name": "name"
          }
        ],
        "created_at": "2024-08-25T15:00:00Z"
      }
    ],
    "domains_count": 0,
    "team_members_count": 0,
    "last_28_days": {
      "messages_transactional": 0,
      "messages_broadcast": 0,
      "messages_inbound": 0,
      "deliverability": 0
    },
    "created_at": "created_at",
    "updated_at": "updated_at"
  },
  "message": "Project created successfully.",
  "api_token": "api_token"
}

json

application/json

Get project details

GET

https://api.lettermint.co/v1

/projects/{projectId}

Bearer

Get project details › path Parameters

projectId

string · required

Get project details › query Parameters

include

string[]

Enum values:

routes

routesCount

routesExists

domains

domainsCount

domainsExists

messageStats

messageStatsCount

Get project details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get project details › Responses

200

ProjectData

ProjectData

id

string · required

name

string · required

smtp_enabled

boolean · required

redact_email_content

boolean · required

default_route_id

string | null · required

token_generated_at

string | null · date-time · required

token_last_used_at

string | null · date-time · required

token_last_used_ip

string | null · required

created_at

string · required

updated_at

string · required

RouteData[]

routes_count

integer

DomainData[]

domains_count

integer

team_members_count

integer

GET/projects/{projectId}

curl https://api.lettermint.co/v1/projects/:projectId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "name": "name",
  "smtp_enabled": true,
  "redact_email_content": true,
  "default_route_id": "default_route_id",
  "token_generated_at": "2024-08-25T15:00:00Z",
  "token_last_used_at": "2024-08-25T15:00:00Z",
  "token_last_used_ip": "token_last_used_ip",
  "routes": [
    {
      "id": "id",
      "project_id": "project_id",
      "slug": "slug",
      "name": "name",
      "route_type": "transactional",
      "is_default": true,
      "inbound_address": "inbound_address",
      "inbound_domain": "inbound_domain",
      "inbound_domain_verified_at": "2024-08-25T15:00:00Z",
      "inbound_spam_threshold": 0,
      "attachment_delivery": "inline",
      "settings": {},
      "webhooks_count": 0,
      "suppressed_recipients_count": 0,
      "statistics": {},
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "routes_count": 0,
  "domains": [
    {
      "id": "id",
      "domain": "domain",
      "status_changed_at": "2024-08-25T15:00:00Z",
      "dns_records": [
        {
          "id": "id",
          "type": "TXT",
          "hostname": "hostname",
          "fqdn": "fqdn",
          "content": "content",
          "status": "active",
          "verified_at": "verified_at",
          "last_checked_at": "2024-08-25T15:00:00Z"
        }
      ],
      "projects": [
        {
          "id": "id",
          "name": "name"
        }
      ],
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "domains_count": 0,
  "team_members_count": 0,
  "last_28_days": {
    "messages_transactional": 0,
    "messages_broadcast": 0,
    "messages_inbound": 0,
    "deliverability": 0
  },
  "created_at": "created_at",
  "updated_at": "updated_at"
}

json

application/json

Update project settings

PUT

https://api.lettermint.co/v1

/projects/{projectId}

Bearer

Update project settings › path Parameters

projectId

string · required

Update project settings › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Update project settings › Request Body

UpdateProjectData

name

string | null · maxLength: 255

smtp_enabled

boolean | null

redact_email_content

boolean | null

default_route_id

string | null · uuid

Update project settings › Responses

ProjectData · required

message

string · const · required

Const value: Project updated successfully.

PUT/projects/{projectId}

curl https://api.lettermint.co/v1/projects/:projectId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "smtp_enabled": true,
  "redact_email_content": true,
  "default_route_id": "00000000-0000-0000-0000-000000000000"
}'

Example Request Body

{
  "name": "name",
  "smtp_enabled": true,
  "redact_email_content": true,
  "default_route_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "smtp_enabled": true,
    "redact_email_content": true,
    "default_route_id": "default_route_id",
    "token_generated_at": "2024-08-25T15:00:00Z",
    "token_last_used_at": "2024-08-25T15:00:00Z",
    "token_last_used_ip": "token_last_used_ip",
    "routes": [
      {
        "id": "id",
        "project_id": "project_id",
        "slug": "slug",
        "name": "name",
        "route_type": "transactional",
        "is_default": true,
        "inbound_address": "inbound_address",
        "inbound_domain": "inbound_domain",
        "inbound_domain_verified_at": "2024-08-25T15:00:00Z",
        "inbound_spam_threshold": 0,
        "attachment_delivery": "inline",
        "settings": {},
        "webhooks_count": 0,
        "suppressed_recipients_count": 0,
        "statistics": {},
        "created_at": "2024-08-25T15:00:00Z",
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "routes_count": 0,
    "domains": [
      {
        "id": "id",
        "domain": "domain",
        "status_changed_at": "2024-08-25T15:00:00Z",
        "dns_records": [
          {
            "id": "id",
            "type": "TXT",
            "hostname": "hostname",
            "fqdn": "fqdn",
            "content": "content",
            "status": "active",
            "verified_at": "verified_at",
            "last_checked_at": "2024-08-25T15:00:00Z"
          }
        ],
        "projects": [
          {
            "id": "id",
            "name": "name"
          }
        ],
        "created_at": "2024-08-25T15:00:00Z"
      }
    ],
    "domains_count": 0,
    "team_members_count": 0,
    "last_28_days": {
      "messages_transactional": 0,
      "messages_broadcast": 0,
      "messages_inbound": 0,
      "deliverability": 0
    },
    "created_at": "created_at",
    "updated_at": "updated_at"
  },
  "message": "Project updated successfully."
}

json

application/json

Delete a project

DELETE

https://api.lettermint.co/v1

/projects/{projectId}

Bearer

Delete a project › path Parameters

projectId

string · required

Delete a project › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Delete a project › Responses

200

message

string · const · required

Const value: Project deleted successfully.

deprecated

Rotate Project API token (legacy)

POST

https://api.lettermint.co/v1

/projects/{projectId}/rotate-token

Bearer

Legacy endpoint that rotates the original Project API token. Use dashboard Project API token management to create, regenerate, or revoke specific tokens.

Rotate Project API token (legacy) › path Parameters

projectId

string · required

Rotate Project API token (legacy) › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Rotate Project API token (legacy) › Responses

200

ProjectData · required

new_token

string · required

message

string · const · required

Const value: API token rotated successfully. Please update your integrations.

POST/projects/{projectId}/rotate-token

curl https://api.lettermint.co/v1/projects/:projectId/rotate-token \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "smtp_enabled": true,
    "redact_email_content": true,
    "default_route_id": "default_route_id",
    "token_generated_at": "2024-08-25T15:00:00Z",
    "token_last_used_at": "2024-08-25T15:00:00Z",
    "token_last_used_ip": "token_last_used_ip",
    "routes": [
      {
        "id": "id",
        "project_id": "project_id",
        "slug": "slug",
        "name": "name",
        "route_type": "transactional",
        "is_default": true,
        "inbound_address": "inbound_address",
        "inbound_domain": "inbound_domain",
        "inbound_domain_verified_at": "2024-08-25T15:00:00Z",
        "inbound_spam_threshold": 0,
        "attachment_delivery": "inline",
        "settings": {},
        "webhooks_count": 0,
        "suppressed_recipients_count": 0,
        "statistics": {},
        "created_at": "2024-08-25T15:00:00Z",
        "updated_at": "2024-08-25T15:00:00Z"
      }
    ],
    "routes_count": 0,
    "domains": [
      {
        "id": "id",
        "domain": "domain",
        "status_changed_at": "2024-08-25T15:00:00Z",
        "dns_records": [
          {
            "id": "id",
            "type": "TXT",
            "hostname": "hostname",
            "fqdn": "fqdn",
            "content": "content",
            "status": "active",
            "verified_at": "verified_at",
            "last_checked_at": "2024-08-25T15:00:00Z"
          }
        ],
        "projects": [
          {
            "id": "id",
            "name": "name"
          }
        ],
        "created_at": "2024-08-25T15:00:00Z"
      }
    ],
    "domains_count": 0,
    "team_members_count": 0,
    "last_28_days": {
      "messages_transactional": 0,
      "messages_broadcast": 0,
      "messages_inbound": 0,
      "deliverability": 0
    },
    "created_at": "created_at",
    "updated_at": "updated_at"
  },
  "new_token": "new_token",
  "message": "API token rotated successfully. Please update your integrations."
}

json

application/json

List routes for a project

GET

https://api.lettermint.co/v1

/projects/{projectId}/routes

Bearer

List routes for a project › path Parameters

projectId

string · required

List routes for a project › query Parameters

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

sort

string[]

Enum values:

name

-name

slug

-slug

created_at

-created_at

Default: ["-created_at"]

filter[route_type]

RouteType · enum

Enum values:

transactional

broadcast

inbound

filter[is_default]

boolean

filter[search]

string

Search by name or slug

List routes for a project › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

List routes for a project › Responses

200

Paginated set of RouteListData

RouteListData[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Create a new route

POST

https://api.lettermint.co/v1

/projects/{projectId}/routes

Bearer

Create a new route › path Parameters

projectId

string · required

Create a new route › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Create a new route › Request Body

StoreRouteData

name

string · maxLength: 255 · required

route_type

RouteType · enum · required

Enum values:

transactional

broadcast

inbound

slug

string | null · maxLength: 255

Create a new route › Responses

RouteData · required

message

string · const · required

Const value: Route created successfully.

POST/projects/{projectId}/routes

curl https://api.lettermint.co/v1/projects/:projectId/routes \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "route_type": "transactional",
  "slug": "slug"
}'

Example Request Body

{
  "name": "name",
  "route_type": "transactional",
  "slug": "slug"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "project_id": "project_id",
    "slug": "slug",
    "name": "name",
    "route_type": "transactional",
    "is_default": true,
    "inbound_address": "inbound_address",
    "inbound_domain": "inbound_domain",
    "inbound_domain_verified_at": "2024-08-25T15:00:00Z",
    "inbound_spam_threshold": 0,
    "attachment_delivery": "inline",
    "settings": {},
    "project": {
      "id": "id",
      "name": "name",
      "smtp_enabled": true,
      "redact_email_content": true,
      "default_route_id": "default_route_id",
      "token_generated_at": "2024-08-25T15:00:00Z",
      "token_last_used_at": "2024-08-25T15:00:00Z",
      "token_last_used_ip": "token_last_used_ip",
      "routes": [
        null
      ],
      "routes_count": 0,
      "domains": [
        {
          "id": "id",
          "domain": "domain",
          "status_changed_at": "2024-08-25T15:00:00Z",
          "dns_records": [
            {
              "id": "id",
              "type": "TXT",
              "hostname": "hostname",
              "fqdn": "fqdn",
              "content": "content",
              "status": "active",
              "verified_at": "verified_at",
              "last_checked_at": "2024-08-25T15:00:00Z"
            }
          ],
          "projects": [
            {
              "id": "id",
              "name": "name"
            }
          ],
          "created_at": "2024-08-25T15:00:00Z"
        }
      ],
      "domains_count": 0,
      "team_members_count": 0,
      "last_28_days": {
        "messages_transactional": 0,
        "messages_broadcast": 0,
        "messages_inbound": 0,
        "deliverability": 0
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    },
    "webhooks_count": 0,
    "suppressed_recipients_count": 0,
    "statistics": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  },
  "message": "Route created successfully."
}

json

application/json

Get route details

GET

https://api.lettermint.co/v1

/routes/{routeId}

Bearer

Get route details › path Parameters

routeId

string · required

Get route details › query Parameters

include_machine

boolean

Default: false

include

string[]

Enum values:

project

projectCount

projectExists

statistics

Get route details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get route details › Responses

200

RouteData

RouteData

id

string · required

project_id

string · required

slug

string · required

name

string · required

route_type

RouteType · enum · required

Enum values:

transactional

broadcast

inbound

is_default

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

inbound_address

string | null

inbound_domain

string | null

inbound_domain_verified_at

string | null · date-time

inbound_spam_threshold

number | null

attachment_delivery

AttachmentDelivery · enum

Enum values:

inline

url

Route settings available for this route type and team feature access

ProjectData

webhooks_count

integer

suppressed_recipients_count

integer

GET/routes/{routeId}

curl https://api.lettermint.co/v1/routes/:routeId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "slug": "slug",
  "name": "name",
  "route_type": "transactional",
  "is_default": true,
  "inbound_address": "inbound_address",
  "inbound_domain": "inbound_domain",
  "inbound_domain_verified_at": "2024-08-25T15:00:00Z",
  "inbound_spam_threshold": 0,
  "attachment_delivery": "inline",
  "settings": {},
  "project": {
    "id": "id",
    "name": "name",
    "smtp_enabled": true,
    "redact_email_content": true,
    "default_route_id": "default_route_id",
    "token_generated_at": "2024-08-25T15:00:00Z",
    "token_last_used_at": "2024-08-25T15:00:00Z",
    "token_last_used_ip": "token_last_used_ip",
    "routes": [
      null
    ],
    "routes_count": 0,
    "domains": [
      {
        "id": "id",
        "domain": "domain",
        "status_changed_at": "2024-08-25T15:00:00Z",
        "dns_records": [
          {
            "id": "id",
            "type": "TXT",
            "hostname": "hostname",
            "fqdn": "fqdn",
            "content": "content",
            "status": "active",
            "verified_at": "verified_at",
            "last_checked_at": "2024-08-25T15:00:00Z"
          }
        ],
        "projects": [
          {
            "id": "id",
            "name": "name"
          }
        ],
        "created_at": "2024-08-25T15:00:00Z"
      }
    ],
    "domains_count": 0,
    "team_members_count": 0,
    "last_28_days": {
      "messages_transactional": 0,
      "messages_broadcast": 0,
      "messages_inbound": 0,
      "deliverability": 0
    },
    "created_at": "created_at",
    "updated_at": "updated_at"
  },
  "webhooks_count": 0,
  "suppressed_recipients_count": 0,
  "statistics": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update route settings

PUT

https://api.lettermint.co/v1

/routes/{routeId}

Bearer

Update route settings › path Parameters

routeId

string · required

Update route settings › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Update route settings › Request Body

UpdateRouteData

name

string | null · maxLength: 255

Update route settings › Responses

RouteData · required

message

string · const · required

Const value: Route updated successfully.

PUT/routes/{routeId}

curl https://api.lettermint.co/v1/routes/:routeId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "settings": {
    "track_opens": true,
    "track_clicks": true,
    "generate_plaintext_fallback": true,
    "suppress_auto_responders": true,
    "disable_hosted_unsubscribe": true,
    "redact_email_content": true
  },
  "inbound_settings": {
    "inbound_domain": "inbound_domain",
    "inbound_spam_threshold": 0,
    "attachment_delivery": "inline"
  }
}'

Example Request Body

{
  "name": "name",
  "settings": {
    "track_opens": true,
    "track_clicks": true,
    "generate_plaintext_fallback": true,
    "suppress_auto_responders": true,
    "disable_hosted_unsubscribe": true,
    "redact_email_content": true
  },
  "inbound_settings": {
    "inbound_domain": "inbound_domain",
    "inbound_spam_threshold": 0,
    "attachment_delivery": "inline"
  }
}

json

Example Responses

{
  "data": {
    "id": "id",
    "project_id": "project_id",
    "slug": "slug",
    "name": "name",
    "route_type": "transactional",
    "is_default": true,
    "inbound_address": "inbound_address",
    "inbound_domain": "inbound_domain",
    "inbound_domain_verified_at": "2024-08-25T15:00:00Z",
    "inbound_spam_threshold": 0,
    "attachment_delivery": "inline",
    "settings": {},
    "project": {
      "id": "id",
      "name": "name",
      "smtp_enabled": true,
      "redact_email_content": true,
      "default_route_id": "default_route_id",
      "token_generated_at": "2024-08-25T15:00:00Z",
      "token_last_used_at": "2024-08-25T15:00:00Z",
      "token_last_used_ip": "token_last_used_ip",
      "routes": [
        null
      ],
      "routes_count": 0,
      "domains": [
        {
          "id": "id",
          "domain": "domain",
          "status_changed_at": "2024-08-25T15:00:00Z",
          "dns_records": [
            {
              "id": "id",
              "type": "TXT",
              "hostname": "hostname",
              "fqdn": "fqdn",
              "content": "content",
              "status": "active",
              "verified_at": "verified_at",
              "last_checked_at": "2024-08-25T15:00:00Z"
            }
          ],
          "projects": [
            {
              "id": "id",
              "name": "name"
            }
          ],
          "created_at": "2024-08-25T15:00:00Z"
        }
      ],
      "domains_count": 0,
      "team_members_count": 0,
      "last_28_days": {
        "messages_transactional": 0,
        "messages_broadcast": 0,
        "messages_inbound": 0,
        "deliverability": 0
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    },
    "webhooks_count": 0,
    "suppressed_recipients_count": 0,
    "statistics": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  },
  "message": "Route updated successfully."
}

json

application/json

Delete a route

DELETE

https://api.lettermint.co/v1

/routes/{routeId}

Bearer

Delete a route › path Parameters

routeId

string · required

Delete a route › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Delete a route › Responses

200

message

string · const · required

Const value: Route deleted successfully.

Verify inbound domain for a route

POST

https://api.lettermint.co/v1

/routes/{routeId}/verify-inbound-domain

Bearer

Verify inbound domain for a route › path Parameters

routeId

string · required

Verify inbound domain for a route › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Verify inbound domain for a route › Responses

object · required

Domain Webhook