User Management

Programmatically manage users connected to your API keys.

How Users Connect

Users connect to your Warm AI account through the Connect Link flow:

1. User clicks the connect link provided to them
2. User signs up for a Warm AI account
3. User connects their LinkedIn account via OAuth
4. User completes the Setup Wizard (4 steps):
   • Add Product — describe what you are selling
   • Profile Settings — configure their outreach profile
   • Review Product — confirm product details
   • Complete — finalise setup and start sending

List Users

Retrieve all users connected to your API key.

Endpoint: GET https://api.warmai.uk/user-list

Headers:

Query Parameters:

Example Request:

curl -X GET "https://api.warmai.uk/user-list?status=active" \
  -H "x-access-key: your_access_key"

Response:

{
  "users": [
    {
      "id": "usr_abc123",
      "linkedin_url": "https://linkedin.com/in/janedoe",
      "linkedin_name": "Jane Doe",
      "status": "active",
      "daily_limit": 25,
      "daily_sent_count": 12
    }
  ]
}

User Management Endpoint

Perform management actions on users connected to your API key.

Endpoint: POST https://api.warmai.uk/functions/v1/api-user-management

Headers:

Add User

Create a new user seat and generate a connect link.

Request:

{
  "action": "add"
}

Response:

{
  "success": true,
  "connect_url": "https://connect.warmai.uk/c/abc123"
}

Share the connect_url with the user to begin the connection flow.

Suspend User

Temporarily disconnect a user’s LinkedIn account while keeping their record intact.

Request:

{
  "action": "suspend",
  "user_id": "usr_abc123"
}

Response:

{
  "success": true,
  "user_id": "usr_abc123",
  "status": "suspended"
}

Unsuspend User

Reactivate a suspended user. A new connect link is returned so they can reconnect their LinkedIn account.

Request:

{
  "action": "unsuspend",
  "user_id": "usr_abc123"
}

Response:

{
  "success": true,
  "user_id": "usr_abc123",
  "status": "pending",
  "connect_url": "https://connect.warmai.uk/c/def456"
}

Migrate Users

Move users from one API key to another. LinkedIn connections are preserved during migration.

Request:

{
  "action": "migrate",
  "user_ids": ["usr_abc123", "usr_def456"],
  "target_access_key": "your_other_access_key"
}

Response:

{
  "success": true,
  "migrated": ["usr_abc123", "usr_def456"],
  "target_access_key": "your_other_access_key"
}

Disconnect User

Permanently remove a user from your account. This action cannot be undone.

Request:

{
  "action": "disconnect",
  "user_id": "usr_abc123"
}

Response:

{
  "success": true,
  "user_id": "usr_abc123",
  "status": "disconnected"
}

Action Summary