Skip to main content
POST
/
leads
Create Lead
curl --request POST \
  --url https://eu-gcp-api.vg-stuff.com/v3/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lead": {
    "agentId": "<string>",
    "email": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "metaData": {
      "address": "<string>",
      "company": "<string>",
      "notes": "<string>",
      "source": "chat"
    }
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": {}
}

​
Example Request

{
  "lead": {
    "agentId": "your_agent_id",
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "metaData": {
      "company": "Acme Inc",
      "source": "api",
      "notes": "Interested in enterprise plan"
    }
  }
}
agentId is required. At least one contact field (email, phone, or name) is recommended.
Use the metaData.source field to track where leads come from (e.g., ‘chat’, ‘web’, ‘api’, ‘import’).

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
lead
object
required

Lead information to create

Response

Successful response

​
success
boolean
required

Indicates if the lead was created successfully

​
message
string
required

Response message

​
data
object

Created lead object with generated ID and timestamps