Create a standalone lead
/v1/leads/createThis endpoint is deprecated but still works. Use Create a lead (POST /v1/leads) instead.
Creates a new lead in your organization without adding it to any campaign. The lead must have first_name, last_name, and at least one of email or linkedin_url.
Headers
AuthorizationstringRequiredBearerfollowed by a space and your API key, for exampleBearer vk_….Idempotency-KeystringAny unique string, such as a UUID, that makes retrying this request safe. A repeat with the same key for at least 24 hours returns the original response instead of doing the work again. Use a new key for each distinct request.
at most 255 characters
Request body
first_namestringRequiredLead's first name
at most 2,000 charactersExample"Sarah"last_namestringRequiredLead's last name
at most 2,000 charactersExample"Johnson"annual_revenueinteger or nullCompany annual revenue in dollars
≥ 0Example5000000companystring or nullCompany name
at most 2,000 charactersExample"Acme Corp"company_websitestring or nullLead's company website URL
at most 2,000 charactersExample"https://acmecorp.com"custom_fieldsobject or nullCustom fields as key-value pairs
emailstring · email or nullLead's email address (required if linkedin_url not provided)
at most 2,000 charactersExample"sarah.johnson@acmecorp.com"employeesinteger or nullNumber of employees at the company
≥ 0Example150industrystring or nullIndustry sector
at most 2,000 charactersExample"Technology"linkedin_urlstring or nullLead's LinkedIn profile URL (required if email not provided)
at most 2,000 charactersExample"https://linkedin.com/in/sarahjohnson"titlestring or nullJob title
at most 2,000 charactersExample"VP of Sales"
Response
201
messagestringRequiredExample"Lead created successfully"lead_idstringRequiredID of the created lead
Example"a1b2c3d4-e5f6-7890-abcd-ef1234567890"leadobjectRequiredThe created lead record
successbooleanDefaulttrue
Errors
Errors share one JSON body: success, error, message, optional details, and request_id.
| Status | Code | Meaning |
|---|---|---|
| 400 | VALIDATION_ERROR | The request didn't match the endpoint's schema: a missing or malformed field, a bad query parameter, or a value out of range. |
| 401 | UNAUTHORIZED | The |
| 401 | API_KEY_EXPIRED | The API key is past its expiry date. Create a new key in the Victoria AI app. |
| 403 | TRIAL_LEAD_CAP_REACHED | The organization is on a free trial and has used up its lead quota, so the lead wasn't created. |
| 403 | INSUFFICIENT_SCOPE | The API key doesn't have the scope this endpoint requires, such as |
| 403 | ORGANIZATION_DEACTIVATED | The organization that owns this API key has been deactivated. |
| 409 | LEAD_ALREADY_EXISTS | A lead with the same email or LinkedIn URL already exists in your organization. From Create a lead, this means the request named no |
| 409 | LEAD_SUPPRESSED | The contact is on your organization's do-not-contact list, so the lead wasn't created, enrolled or updated. |
| 409 | IDEMPOTENCY_KEY_REUSED | This |
| 409 | IDEMPOTENCY_IN_PROGRESS | The first request with this |
| 413 | PAYLOAD_TOO_LARGE | The request body is larger than 1 MB. |
| 429 | RATE_LIMITED | Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the |
| 500 | INTERNAL_ERROR | Something failed on our side. The response never includes internal details; quote its |
| 503 | UPSTREAM_TIMEOUT | A service the API depends on timed out. The request is safe to retry. |
| 503 | AUTH_UNAVAILABLE | The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry. |
Response headers
| Header | Description |
|---|---|
X-Request-ID | Correlation ID for the request, also returned as |
RateLimit-Limit | Requests allowed to this endpoint per minute. |
RateLimit-Remaining | Requests you can still send to this endpoint right now. |
RateLimit-Reset | Seconds until the endpoint's full limit is available again. |
Retry-After | On a |
Idempotent-Replay |
|
Deprecation |
|
Link |
|