Start Import Queue

POST /v1/agents/import-queue

Start Import Queue

cURL

curl --request POST \
  --url https://api.bizzy.ai/v1/agents/import-queue \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agentId": 123
}'

Response - 200

{
  "sessionId": 3456789,
  "agentId": 1234567
}

Create a new import queue session for a specific agent. This starts a batch import process that you can add companies to.

Request

Body

agentId · number · required

The ID of the agent to import companies into (from the agent overview endpoint)

Response

Response - 200

{
  "sessionId": 3456789,
  "agentId": 1234567
}

sessionId · number

The unique identifier for the created import session. Use this ID to add companies and complete the session.

agentId · number

The ID of the agent this session belongs to

Prerequisites

Before starting an import queue, ensure:

1. The agent has an API input channel configured in the Bizzy platform
2. No other import queue is currently processing for this agent

Next Steps

After creating a session:

1. Use the returned sessionId to add companies to the queue
2. When all companies are added, complete the session to trigger processing

Important: Completing a new import session will replace all companies from previous API imports. If you need to retain existing companies, include them in your new import session. See Complete Import Queue for details.