Generate Token

Authenticates a user with email/password and returns a bearer token valid for 30 days. If a 401 Unauthorized is returned on any other endpoint, regenerate the token and retry.

Request Body Fields

Request Body Example

{
  "email": "user@example.com",
  "password": "your_password"
}

Response (200 OK)

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5..."
}

Error Responses

List Campaigns

Returns a list of campaigns for a company.

Authentication

Authorization: Bearer <token>

Query Parameters

Response (200 OK)

[
  {
    "id": "123",
    "name": "My Campaign",
    "status": "running",
    "type": "outbound",
    "communicationChannelToUse": 1,
    "statistics": {},
    "createdAt": "2024-01-01T00:00:00.000Z"
  }
]

Error Responses

Get Campaign

Returns full details for a single campaign.

Authentication

Authorization: Bearer <token>

Path Parameters

Query Parameters

Response (200 OK)

{
  "id": "123",
  "name": "My Campaign",
  "status": "running",
  "type": "outbound",
  "objective": "...",
  "initialMessage": "Hello!",
  "communicationChannelToUse": 1,
  "statistics": {},
  "analytics": {},
  "batches": [],
  "createdAt": "2024-01-01T00:00:00.000Z"
}

Error Responses

Update Campaign

Updates a campaign. Send only the fields you want to change — everything else is left untouched. Unknown fields are rejected. Concurrency is handled for you: the API reads the campaign's current revision before applying the update.

Authentication

Authorization: Bearer <token>

Path Parameters

Request Body Fields

Request Body Example

{
  "companyId": "456",
  "name": "Q3 Founders Outreach",
  "objective": "Book demos with seed-stage founders",
  "communicationChannelToUse": 1,
  "initialMessage": "Hi {{name}}, saw you're building in devtools..."
}

Response (200 OK)

{
  "updated": true,
  "status": 200,
  "payload": {}
}

Error Responses

List Campaign Users

Returns a paginated list of users in a campaign.

Authentication

Authorization: Bearer <token>

Path Parameters

Query Parameters

Response (200 OK)

[
  {
    "id": "456",
    "name": "John Doe",
    "phoneNumber": "+1234567890",
    "email": null,
    "linkedinChannelDetails": null,
    "tags": [],
    "aiChatOff": false,
    "status": 1,
    "lastMessageCreatedAt": "2024-01-01T00:00:00.000Z",
    "createdAt": "2024-01-01T00:00:00.000Z"
  }
]

Error Responses

Get User Conversation

Returns messages in a user's conversation within a campaign, ordered oldest first.

Authentication

Authorization: Bearer <token>

Path Parameters

Query Parameters

Response (200 OK)

[
  {
    "id": "789",
    "senderType": "bot",
    "content": "Hello, welcome!",
    "type": "text",
    "status": 2,
    "communicationChannelUsed": 1,
    "trigger": "initial",
    "scheduledFor": null,
    "createdAt": "2024-01-01T00:00:00.000Z"
  }
]

Error Responses

List Human Intervention Users

Returns users in the campaign that require human intervention.

Authentication

Authorization: Bearer <token>

Path Parameters

Query Parameters

Response (200 OK)

[
  {
    "id": "456",
    "name": "John Doe",
    "phoneNumber": "+1234567890",
    "email": null,
    "linkedinChannelDetails": null,
    "tags": [],
    "aiChatOff": false,
    "status": 1,
    "lastMessageCreatedAt": "2024-01-01T00:00:00.000Z",
    "createdAt": "2024-01-01T00:00:00.000Z"
  }
]

Error Responses

Generate Campaign

AI-generates a new campaign based on a natural language description.

Authentication

Authorization: Bearer <token>

Request Body Fields

Request Body Example

{
  "companyId": "123",
  "description": "Reach out to CTOs at fintech companies about our new product",
  "communicationChannel": 1
}

Response (200 OK)

{
  "id": "456",
  "pendingCommentToDM": false,
  "pendingMetaAdId": false,
  "pendingProductLinks": []
}

Error Responses

Send Message in Campaign

Sends a message to a specific user in a campaign.

Authentication

Authorization: Bearer <token>

Path Parameters

Request Body Fields

Request Body Example

{
  "userId": "789",
  "message": "Hello, following up on our conversation!"
}

Response (200 OK)

{
  "messageId": "xxxx"
}

Error Responses

Add User to Campaign

Adds a new user to a campaign. WhatsApp campaigns require phoneNumber; LinkedIn campaigns require linkedinProfileUrl. LinkedIn campaigns can also include customMessage for templates that use [custom message].

Authentication

Authorization: Bearer <token>

Path Parameters

Request Body Fields

Request Body Example

{
  "name": "John Doe",
  "linkedinProfileUrl": "https://www.linkedin.com/in/johndoe",
  "customVariables": {
    "company": "Acme Inc",
    "role": "CTO"
  },
  "customMessage": "I noticed Acme recently expanded its engineering team."
}

Response (200 OK)

This endpoint returns an empty response body (HTTP 200).

Error Responses