Sources
A source is where messages come from: the API, an email address generated for you, or a web form URL. Each source can use its own profile.
The Source object
Properties
- Name
object- Type
- 'source'
- Description
The object type.
- Name
id- Type
- string
- Description
Unique identifier, prefixed by the object type.
- Name
workspaceId- Type
- string
- Description
The workspace this object belongs to.
- Name
type- Type
- 'api' | 'email' | 'form' | 'telegram' | 'google_ads' | 'facebook_lead_ads'
- Description
Type.
- Name
name- Type
- string
- Description
Display name.
- Name
status- Type
- 'active' | 'paused' | 'error' | 'pending_setup'
- Description
Current status.
- Name
profileId- Type
- string or null
- Description
Profile for this source's messages; null = workspace default
- Name
config- Type
- object
- Description
- Name
stats- Type
- object
- Description
- Name
createdAt- Type
- string
- Description
When it was created (ISO 8601).
- Name
updatedAt- Type
- string
- Description
When it was last changed (ISO 8601).
List the workspace's message sources
Query parameters
- Name
limit- Type
- integer
- Description
1–100, default 20
- Name
starting_after- Type
- string
- Description
ID of the last item of the previous page
Request
curl https://core.leadveyor.com/v1/sources \
-H "Authorization: Bearer {api_key}" \
-H "Leadveyor-Workspace: {workspace_id}" # account-wide keys only
Response 200
{
"object": "list",
"data": [
{
"object": "source",
"id": "src_IhKtJ0RlgLKOmxgJTeKdNnFR",
"workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
"type": "form",
"name": "Website form check",
"status": "active",
"profileId": null,
"config": {
"token": "frm_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm5Jy0Gs",
"redirectUrl": "https://leadveyor.com/thanks",
"url": "https://core.leadveyor.com/f/frm_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm5Jy0Gs"
},
"stats": {
"total": 3,
"lastInboundAt": "2026-10-23T15:07:38.057Z"
},
"createdAt": "2026-10-23T15:07:20.162Z",
"updatedAt": "2026-10-23T15:07:20.162Z"
}
],
"has_more": false,
"next_cursor": null
}
Add a source
Required attributes
- Name
type- Type
- 'api' | 'email' | 'form' | 'telegram' | 'google_ads' | 'facebook_lead_ads'
- Description
Available now: api, email (you get an address to forward mail to), form (you get a URL to post forms to). Others later.
Optional attributes
- Name
name- Type
- string
- Description
Display name.
- Name
profileId- Type
- string or null
- Description
- Name
redirectUrl- Type
- string or null
- Description
form: page to send people to after a classic HTML form submit
Request
curl -X POST https://core.leadveyor.com/v1/sources \
-H "Authorization: Bearer {api_key}" \
-H "Leadveyor-Workspace: {workspace_id}" # account-wide keys only \
-H "Content-Type: application/json" \
-d '{
"type": "api",
"name": "name",
"profileId": null,
"redirectUrl": null
}'
Response 201
{
"object": "source",
"id": "src_IhKtJ0RlgLKOmxgJTeKdNnFR",
"workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
"type": "form",
"name": "Website form check",
"status": "active",
"profileId": null,
"config": {
"token": "frm_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm5Jy0Gs",
"redirectUrl": "https://leadveyor.com/thanks",
"url": "https://core.leadveyor.com/f/frm_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm5Jy0Gs"
},
"stats": {
"total": 3,
"lastInboundAt": "2026-10-23T15:07:38.057Z"
},
"createdAt": "2026-10-23T15:07:20.162Z",
"updatedAt": "2026-10-23T15:07:20.162Z"
}
Get a source
Path parameters
- Name
id- Type
- string
- Description
Unique identifier, prefixed by the object type.
Request
curl https://core.leadveyor.com/v1/sources/src_4Hd8Kq2Lm7Xp1Vz9Rt3Bc6Nw \
-H "Authorization: Bearer {api_key}" \
-H "Leadveyor-Workspace: {workspace_id}" # account-wide keys only
Response 200
{
"object": "source",
"id": "src_IhKtJ0RlgLKOmxgJTeKdNnFR",
"workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
"type": "form",
"name": "Website form check",
"status": "active",
"profileId": null,
"config": {
"token": "frm_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm5Jy0Gs",
"redirectUrl": "https://leadveyor.com/thanks",
"url": "https://core.leadveyor.com/f/frm_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm5Jy0Gs"
},
"stats": {
"total": 3,
"lastInboundAt": "2026-10-23T15:07:38.057Z"
},
"createdAt": "2026-10-23T15:07:20.162Z",
"updatedAt": "2026-10-23T15:07:20.162Z"
}
Rename, change profile, pause or resume a source
Path parameters
- Name
id- Type
- string
- Description
Unique identifier, prefixed by the object type.
Optional attributes
- Name
name- Type
- string
- Description
Display name.
- Name
profileId- Type
- string or null
- Description
- Name
status- Type
- 'active' | 'paused'
- Description
Current status.
- Name
redirectUrl- Type
- string or null
- Description
form sources only
Request
curl -X PATCH https://core.leadveyor.com/v1/sources/src_4Hd8Kq2Lm7Xp1Vz9Rt3Bc6Nw \
-H "Authorization: Bearer {api_key}" \
-H "Leadveyor-Workspace: {workspace_id}" # account-wide keys only \
-H "Content-Type: application/json" \
-d '{
"name": "name",
"profileId": null,
"status": "active",
"redirectUrl": null
}'
Response 200
{
"object": "source",
"id": "src_IhKtJ0RlgLKOmxgJTeKdNnFR",
"workspaceId": "ws_Bd0Kh8oOOL8dKLzdocJ2isAj",
"type": "form",
"name": "Website form check",
"status": "active",
"profileId": null,
"config": {
"token": "frm_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm5Jy0Gs",
"redirectUrl": "https://leadveyor.com/thanks",
"url": "https://core.leadveyor.com/f/frm_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm5Jy0Gs"
},
"stats": {
"total": 3,
"lastInboundAt": "2026-10-23T15:07:38.057Z"
},
"createdAt": "2026-10-23T15:07:20.162Z",
"updatedAt": "2026-10-23T15:07:20.162Z"
}
Delete a source (its messages and leads are kept)
Path parameters
- Name
id- Type
- string
- Description
Unique identifier, prefixed by the object type.
Request
curl -X DELETE https://core.leadveyor.com/v1/sources/src_4Hd8Kq2Lm7Xp1Vz9Rt3Bc6Nw \
-H "Authorization: Bearer {api_key}" \
-H "Leadveyor-Workspace: {workspace_id}" # account-wide keys only
Response 200
{
"object": "source",
"id": "id",
"deleted": true
}