ClawdMaildocs

Projects

Campaign context templates for consistent email generation.

GET/api/v1/projects

List all projects in your organization. Returns projects sorted by creation date.

Example

curl https://app.clawdmail.ai/api/v1/projects \
  -H "Authorization: Bearer cm_live_your_key"

Response

{
  "data": {
    "projects": [
      {
        "id": "proj_8f3a1b2c4d5e",
        "name": "Product Launch Q2",
        "description": "Email campaigns for the Q2 product launch",
        "archetype": "product-update",
        "tone": "professional",
        "audienceDescription": "Existing customers and trial users",
        "createdAt": "2026-02-10T09:00:00Z"
      }
    ]
  }
}
POST/api/v1/projects

Create a new project. Projects provide context that the AI uses to generate consistent, on-brand emails.

Parameters

NameTypeDescription
namerequiredstringDisplay name for the project
descriptionstringWhat this project is about
archetypestringCampaign archetype — e.g. "newsletter", "product-update", "onboarding"
tonestringDesired voice — e.g. "professional", "casual", "friendly"
audienceDescriptionstringWho the emails are for

Example

curl -X POST https://app.clawdmail.ai/api/v1/projects \
  -H "Authorization: Bearer cm_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly Newsletter",
    "description": "Our weekly product and community digest",
    "archetype": "newsletter",
    "tone": "casual",
    "audienceDescription": "Active subscribers interested in product updates"
  }'

Response

{
  "data": {
    "id": "proj_7c4e2a9b1d3f",
    "name": "Weekly Newsletter",
    "description": "Our weekly product and community digest",
    "archetype": "newsletter",
    "tone": "casual",
    "audienceDescription": "Active subscribers interested in product updates",
    "createdAt": "2026-03-04T12:00:00Z"
  }
}
GET/api/v1/projects/:id

Retrieve a single project by its ID.

Parameters

NameTypeDescription
idrequiredstringProject ID

Example

curl https://app.clawdmail.ai/api/v1/projects/proj_7c4e2a9b1d3f \
  -H "Authorization: Bearer cm_live_your_key"
PUT/api/v1/projects/:id

Update an existing project. Pass all fields you want to set — omitted fields remain unchanged.

Parameters

NameTypeDescription
idrequiredstringProject ID
namestringUpdated project name
descriptionstringUpdated description
archetypestringUpdated campaign archetype
tonestringUpdated tone
audienceDescriptionstringUpdated audience description

Example

curl -X PUT https://app.clawdmail.ai/api/v1/projects/proj_7c4e2a9b1d3f \
  -H "Authorization: Bearer cm_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly Newsletter",
    "tone": "professional"
  }'
DELETE/api/v1/projects/:id

Permanently delete a project. Campaigns associated with this project are not deleted but will lose their project context.

Parameters

NameTypeDescription
idrequiredstringProject ID

Example

curl -X DELETE https://app.clawdmail.ai/api/v1/projects/proj_7c4e2a9b1d3f \
  -H "Authorization: Bearer cm_live_your_key"

Response

{
  "data": {
    "deleted": true
  }
}