Skip to content

AI Email Marketing

Email accounts

The mailboxes your campaigns send from, with their daily limit, reputation and warmup health. Mailboxes are connected in the app.

List email accounts

GET/api/v1/email-accounts

Every mailbox in the workspace.

Any API key, read-only included.

Parameters

NameTypeDescription
active query boolean Only active (true) or paused (false) mailboxes.

Errors

  • 401Missing or invalid key
  • 422Invalid input, or not ready; the body has message and an errors object, one entry per field
  • 429More than 120 requests a minute
Request
curl https://app.zicreach.com/api/v1/email-accounts \
  -H "Authorization: Bearer zk_your_key"
Response200
{
    "data": [
        {
            "id": "9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10",
            "email": "sara@acme.io",
            "display_name": "Sara Khan",
            "provider": "google",
            "is_active": true,
            "daily_send_limit": 40,
            "sent_today": 12,
            "reputation_score": 92.5,
            "warmup": {
                "enabled": true,
                "health_score": 97
            },
            "created_at": "2026-09-01T10:00:00Z"
        }
    ]
}

Get an email account

GET/api/v1/email-accounts/{id}

One mailbox.

Any API key, read-only included.

Parameters

NameTypeDescription
idrequired path uuid Mailbox id.

Errors

  • 401Missing or invalid key
  • 404Not found in this workspace
  • 422Invalid input, or not ready; the body has message and an errors object, one entry per field
  • 429More than 120 requests a minute
Request
curl https://app.zicreach.com/api/v1/email-accounts/9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10 \
  -H "Authorization: Bearer zk_your_key"
Response200
{
    "data": {
        "id": "9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10",
        "email": "sara@acme.io",
        "display_name": "Sara Khan",
        "provider": "google",
        "is_active": true,
        "daily_send_limit": 40,
        "sent_today": 12,
        "reputation_score": 92.5,
        "warmup": {
            "enabled": true,
            "health_score": 97
        },
        "created_at": "2026-09-01T10:00:00Z"
    }
}

Pause a mailbox

POST/api/v1/email-accounts/{id}/pause

Stops the mailbox sending campaign emails until resumed.

Needs a read and write API key.

Parameters

NameTypeDescription
idrequired path uuid Mailbox id.

Errors

  • 401Missing or invalid key
  • 403Read-only key used for a change, or a key made by someone who is no longer an owner or admin
  • 404Not found in this workspace
  • 422Invalid input, or not ready; the body has message and an errors object, one entry per field
  • 429More than 120 requests a minute
Request
curl -X POST https://app.zicreach.com/api/v1/email-accounts/9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10/pause \
  -H "Authorization: Bearer zk_your_key"
Response200
{
    "message": "Mailbox paused. It will not send until resumed.",
    "data": {
        "id": "9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10",
        "email": "sara@acme.io",
        "display_name": "Sara Khan",
        "provider": "google",
        "is_active": false,
        "daily_send_limit": 40,
        "sent_today": 12,
        "reputation_score": 92.5,
        "warmup": {
            "enabled": true,
            "health_score": 97
        },
        "created_at": "2026-09-01T10:00:00Z"
    }
}

Resume a mailbox

POST/api/v1/email-accounts/{id}/resume

Lets the mailbox send again.

Needs a read and write API key.

Parameters

NameTypeDescription
idrequired path uuid Mailbox id.

Errors

  • 401Missing or invalid key
  • 403Read-only key used for a change, or a key made by someone who is no longer an owner or admin
  • 404Not found in this workspace
  • 422Invalid input, or not ready; the body has message and an errors object, one entry per field
  • 429More than 120 requests a minute
Request
curl -X POST https://app.zicreach.com/api/v1/email-accounts/9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10/resume \
  -H "Authorization: Bearer zk_your_key"
Response200
{
    "message": "Mailbox resumed.",
    "data": {
        "id": "9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10",
        "email": "sara@acme.io",
        "display_name": "Sara Khan",
        "provider": "google",
        "is_active": true,
        "daily_send_limit": 40,
        "sent_today": 12,
        "reputation_score": 92.5,
        "warmup": {
            "enabled": true,
            "health_score": 97
        },
        "created_at": "2026-09-01T10:00:00Z"
    }
}