Sender Emails

List sender emails

get

Lists all sender emails for the authenticated user's space with optional filtering by campaign ID and connection status. Supports pagination.

Authorizations

AuthorizationstringRequired

Query parameters

pageintegerOptional

Page number (default: 1)

spaceIdintegerOptional

Filter by space ID

campaignIdintegerOptional

Filter by campaign ID

isConnectedbooleanOptional

Filter by connection status

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

List of sender emails

application/json

hasMorebooleanOptional

limitintegerOptional

pageintegerOptional

totalintegerOptional

400

Invalid query parameters

application/json

401

Unauthorized - invalid or missing API key

application/json

500

Failed to retrieve sender emails

application/json

get/sender-emails

GET /r/sender-emails HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "hasMore": true,
  "limit": 1,
  "page": 1,
  "senderEmails": [
    {
      "address": "john@example.com",
      "campaignIds": [
        1,
        2,
        3
      ],
      "createdAt": "2024-01-10T10:30:00Z",
      "currentDailyLimit": 35,
      "familyName": "Doe",
      "givenName": "John",
      "id": 123,
      "isConnected": true,
      "manuallyDisconnected": false,
      "maximumSendingsLimitPerDay": 50,
      "minimumSendingsLimitPerDay": 20,
      "provider": "google",
      "toggleGradualBuildUp": true,
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 1
}

Connect an SMTP/IMAP sender email

post

Connects an SMTP/IMAP mailbox to the workspace using an app password, with no browser step. Google and Microsoft mailboxes are not supported here because both require an interactive consent screen; connect those in the app. The address must be a business domain.

Authorizations

AuthorizationstringRequired

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Body

emailstringRequired

firstNamestring · max: 255Optional

imapServerUrlstring · min: 1Required

ImapServerUrl and SmtpServerUrl accept the provider's host, optionally with a port, for example "imap.fastmail.com:993".

lastNamestring · max: 255Optional

loginStringstringOptional

LoginString defaults to the email address when omitted, which is what most providers expect.

passwordstring · min: 1Required

smtpServerUrlstring · min: 1Required

Responses

201

Sender email connected successfully

application/json

messagestringOptionalExample: sender email connected successfully

400

Invalid request body or non-business email address

application/json

401

Unauthorized - invalid or missing API key

application/json

402

Plan does not allow another sender email

application/json

409

Email already connected to another workspace

application/json

500

Failed to connect sender email

application/json

502

Mail provider rejected the credentials

application/json

post/sender-emails

POST /r/sender-emails HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "email": "text",
  "firstName": "text",
  "imapServerUrl": "text",
  "lastName": "text",
  "loginString": "text",
  "password": "text",
  "smtpServerUrl": "text"
}

{
  "message": "sender email connected successfully",
  "senderEmail": {
    "address": "john@example.com",
    "campaignIds": [
      1,
      2,
      3
    ],
    "connectionHistory": [
      {
        "campaignId": 10,
        "createdAt": "2024-01-15T10:30:00Z",
        "disconnectionReason": "token_expired",
        "errorCode": "AUTH_FAILED",
        "errorMessage": "Token has expired",
        "eventType": "disconnected",
        "id": 456,
        "userId": 5
      }
    ],
    "createdAt": "2024-01-10T10:30:00Z",
    "currentDailyLimit": 35,
    "errorCode": "AUTH_FAILED",
    "errorMessage": "Authentication failed",
    "familyName": "Doe",
    "givenName": "John",
    "id": 123,
    "isConnected": true,
    "lastDisconnectedAt": "2024-01-15T10:30:00Z",
    "lastReconnectedAt": "2024-01-16T09:00:00Z",
    "manuallyDisconnected": false,
    "maximumSendingsLimitPerDay": 50,
    "minimumSendingsLimitPerDay": 20,
    "pictureUrl": "https://example.com/avatar.jpg",
    "provider": "google",
    "provisioningStatus": "complete",
    "signature": "Best regards,\nJohn Doe",
    "toggleGradualBuildUp": true,
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

Get a sender email by ID

get

Retrieves detailed information about a specific sender email including connection status, limits, and settings.

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Sender Email ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

Sender email details

application/json

400

Invalid sender email ID

application/json

401

Unauthorized - invalid or missing API key

application/json

403

Forbidden - sender email does not belong to your space

application/json

404

Sender email not found

application/json

get/sender-emails/{id}

GET /r/sender-emails/{id} HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "senderEmail": {
    "address": "john@example.com",
    "campaignIds": [
      1,
      2,
      3
    ],
    "connectionHistory": [
      {
        "campaignId": 10,
        "createdAt": "2024-01-15T10:30:00Z",
        "disconnectionReason": "token_expired",
        "errorCode": "AUTH_FAILED",
        "errorMessage": "Token has expired",
        "eventType": "disconnected",
        "id": 456,
        "userId": 5
      }
    ],
    "createdAt": "2024-01-10T10:30:00Z",
    "currentDailyLimit": 35,
    "errorCode": "AUTH_FAILED",
    "errorMessage": "Authentication failed",
    "familyName": "Doe",
    "givenName": "John",
    "id": 123,
    "isConnected": true,
    "lastDisconnectedAt": "2024-01-15T10:30:00Z",
    "lastReconnectedAt": "2024-01-16T09:00:00Z",
    "manuallyDisconnected": false,
    "maximumSendingsLimitPerDay": 50,
    "minimumSendingsLimitPerDay": 20,
    "pictureUrl": "https://example.com/avatar.jpg",
    "provider": "google",
    "provisioningStatus": "complete",
    "signature": "Best regards,\nJohn Doe",
    "toggleGradualBuildUp": true,
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

Update a sender email by ID

put

Updates an existing sender email's information. Only provided fields will be updated. Can update name, signature, and daily sending limits.

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Sender Email ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Body

currentDailyLimitinteger · max: 1000Optional

familyNamestring · max: 255Optional

givenNamestring · min: 1 · max: 255Optional

maximumSendingsLimitPerDayinteger · min: 1 · max: 1000Optional

Daily sending limits

minimumSendingsLimitPerDayinteger · min: 1 · max: 1000Optional

signaturestringOptional

toggleGradualBuildUpbooleanOptional

Gradual build-up toggle

Responses

200

Sender email updated successfully

application/json

messagestringOptionalExample: sender email updated successfully

400

Invalid sender email ID or request body

application/json

401

Unauthorized - invalid or missing API key

application/json

403

Forbidden - sender email does not belong to your space

application/json

404

Sender email not found

application/json

500

Failed to update sender email

application/json

put/sender-emails/{id}

PUT /r/sender-emails/{id} HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "currentDailyLimit": 1,
  "familyName": "text",
  "givenName": "text",
  "maximumSendingsLimitPerDay": 1,
  "minimumSendingsLimitPerDay": 1,
  "signature": "text",
  "toggleGradualBuildUp": true
}

{
  "message": "sender email updated successfully",
  "senderEmail": {
    "address": "john@example.com",
    "campaignIds": [
      1,
      2,
      3
    ],
    "connectionHistory": [
      {
        "campaignId": 10,
        "createdAt": "2024-01-15T10:30:00Z",
        "disconnectionReason": "token_expired",
        "errorCode": "AUTH_FAILED",
        "errorMessage": "Token has expired",
        "eventType": "disconnected",
        "id": 456,
        "userId": 5
      }
    ],
    "createdAt": "2024-01-10T10:30:00Z",
    "currentDailyLimit": 35,
    "errorCode": "AUTH_FAILED",
    "errorMessage": "Authentication failed",
    "familyName": "Doe",
    "givenName": "John",
    "id": 123,
    "isConnected": true,
    "lastDisconnectedAt": "2024-01-15T10:30:00Z",
    "lastReconnectedAt": "2024-01-16T09:00:00Z",
    "manuallyDisconnected": false,
    "maximumSendingsLimitPerDay": 50,
    "minimumSendingsLimitPerDay": 20,
    "pictureUrl": "https://example.com/avatar.jpg",
    "provider": "google",
    "provisioningStatus": "complete",
    "signature": "Best regards,\nJohn Doe",
    "toggleGradualBuildUp": true,
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

PreviousLeads NextWorkspace

Last updated 15 days ago