Skip to main content
API docs by Redocly

Yadulink Public API (v1)

Download OpenAPI specification:Download

Yadulink support: support@yadulink.com URL: https://yadulink.com/contact

Public Yadulink API for API credits, n8n, webhooks, jobs, leads and lists.

Yadulink API guides: authentication, credits, jobs, webhooks and n8n.

Versioning and deprecation policy

The API is versioned in the URL path (/api/v1/). Breaking changes only ship in a new path version (for example /api/v2/). Deprecated fields and operations keep working during a documented migration window and are announced with Deprecation and Sunset response headers plus the changelog at https://yadulink.com/changelog before removal.

Reliability contract

Errors are always JSON with a machine-readable error.code. Write operations accept an Idempotency-Key header (safe retries; conflicting reuse returns 409). Long-running LinkedIn actions run as asynchronous jobs: POST /actions/{operation}/jobs returns 202 Accepted and GET /jobs/{job_id} reports progress. Responses carry IETF RateLimit headers; on 429, honor Retry-After.

Authentication guide: https://yadulink.com/auth.md

Account

Authentication check, eligibility, limits and the machine-readable contract.

Test authentication and retrieve the API key owner.

Test authentication and retrieve the API key owner.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Check API eligibility, subscription access, and LinkedIn connection status.

Check API eligibility, subscription access, and LinkedIn connection status.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Read rate limits, credit allowance, and action-job availability.

Read rate limits, credit allowance, and action-job availability.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Machine-readable public API contract for integrations such as n8n.

Machine-readable public API contract for integrations such as n8n.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Credits

Credit balance, ledger, price quotes and credit packs.

Read the current API credit balance.

Read the current API credit balance.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Read credit ledger entries with pagination and filters.

Read credit ledger entries with pagination and filters.

Authorizations:
bearerApiKey
query Parameters
page
integer >= 1
per_page
integer [ 1 .. 100 ]
type
string
operation
string
api_key_id
integer
date_from
string <date>
date_to
string <date>

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Read credit balance and consumption aggregates for a selected period.

Read credit balance and consumption aggregates for a selected period.

Authorizations:
bearerApiKey
query Parameters
period
string
Default: "cycle"
Enum: "7d" "30d" "cycle"
api_key_id
integer
operation
string

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

List purchasable credit packs. Checkout must be started in the app session.

List purchasable credit packs. Checkout must be started in the app session.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Create a Stripe Checkout session for a credit pack from an authenticated app session.

Create a Stripe Checkout session for a credit pack from an authenticated app session.

Authorizations:
cookieAuth
path Parameters
pack_id
required
string

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Preview the credit cost of an operation before creating it.

Preview the credit cost of an operation before creating it.

Authorizations:
bearerApiKey
Request Body schema: application/json
required
operation
required
string
quantity
integer >= 1
Default: 1
object

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{
  • "operation": "send_connection_request",
  • "quantity": 25
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Lists

Lead lists: the containers a sequence is run against.

List lead lists.

List lead lists.

Authorizations:
bearerApiKey
query Parameters
page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Create a lead list.

Create a lead list.

Authorizations:
bearerApiKey
query Parameters
page
integer >= 1
per_page
integer [ 1 .. 100 ]
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
required
name
required
string

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{
  • "name": "Prospects septembre 2026"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Retrieve a lead list.

Retrieve a lead list.

Authorizations:
bearerApiKey
path Parameters
list_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Update a lead list.

Update a lead list.

Authorizations:
bearerApiKey
path Parameters
list_id
required
integer
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
required
name
string

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Delete a lead list.

Delete a lead list.

Authorizations:
bearerApiKey
path Parameters
list_id
required
integer
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

List leads from a specific list.

List leads from a specific list.

Authorizations:
bearerApiKey
path Parameters
list_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Leads

Leads inside a list, with search and filters.

List leads with filters and pagination.

List leads with filters and pagination.

Authorizations:
bearerApiKey
query Parameters
page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Create a lead.

Create a lead.

Authorizations:
bearerApiKey
query Parameters
page
integer >= 1
per_page
integer [ 1 .. 100 ]
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
required
list_id
required
integer
full_name
required
string
first_name
string
last_name
string
company_name
string
position
string
link
string <uri>
email
string <email>
phone
string
source
string

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Retrieve a lead.

Retrieve a lead.

Authorizations:
bearerApiKey
path Parameters
lead_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Update a lead.

Update a lead.

Authorizations:
bearerApiKey
path Parameters
lead_id
required
integer
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
required
full_name
string
first_name
string
last_name
string
company_name
string
position
string
link
string <uri>
email
string <email>
phone
string
status
string

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{
  • "full_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "company_name": "string",
  • "position": "string",
  • "link": "http://example.com",
  • "email": "user@example.com",
  • "phone": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Delete a lead.

Delete a lead.

Authorizations:
bearerApiKey
path Parameters
lead_id
required
integer
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Actions

LinkedIn-side actions. They never run inline: each one creates a job so credits can be reserved, safety budgets enforced, and the reservation refunded when the action fails.

List LinkedIn-side async actions available through the public API.

List LinkedIn-side async actions available through the public API.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Create an async job for a LinkedIn action.

Create an async job for a LinkedIn action.

Authorizations:
bearerApiKey
path Parameters
operation
required
string
header Parameters
Idempotency-Key
required
string

Required for LinkedIn action mutations. Reuse the same value only when retrying the exact same request; a different payload returns idempotency_key_reused.

Request Body schema: application/json
required
lead_id
integer
profile_id
string
provider_id
string
public_identifier
string
profile_url
string <uri>
post_id
string
message
string
note
string
comment
string

Responses

Response Headers
Location
string

Status URL of the created job.

X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
required
object
object

Request samples

Content type
application/json
{
  • "lead_id": 123
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Jobs

Status and cancellation of the asynchronous jobs actions create.

Retrieve job status and result.

Retrieve job status and result.

Authorizations:
bearerApiKey
path Parameters
job_id
required
string <uuid>

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Cancel a queued/running public API job and refund reserved credits when possible.

Cancel a queued/running public API job and refund reserved credits when possible.

Authorizations:
bearerApiKey
path Parameters
job_id
required
string <uuid>
header Parameters
Idempotency-Key
required
string

Required for LinkedIn action mutations. Reuse the same value only when retrying the exact same request; a different payload returns idempotency_key_reused.

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Messages

LinkedIn conversations synced to Yadulink, read-only.

List LinkedIn conversations synced to Yadulink.

List LinkedIn conversations synced to Yadulink.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Retrieve one synced LinkedIn message.

Retrieve one synced LinkedIn message.

Authorizations:
bearerApiKey
path Parameters
message_id
required
string

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Webhooks

Outbound event delivery: endpoints, signatures, health and replays.

List webhook endpoints.

List webhook endpoints.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Create a webhook endpoint.

Create a webhook endpoint.

Authorizations:
bearerApiKey
Request Body schema: application/json
required
url
required
string <uri>
events
required
Array of strings
Items Enum: "lead.created" "lead.status_changed" "connection.accepted" "radar.connection_accepted" "radar.message_received" "job.completed" "job.failed" "job.canceled"
description
string

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

List unhealthy webhook endpoints and health counters.

List unhealthy webhook endpoints and health counters.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Retrieve one webhook endpoint with health state.

Retrieve one webhook endpoint with health state.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Update a webhook endpoint.

Update a webhook endpoint.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer
Request Body schema: application/json
required
url
string <uri>
events
Array of strings
Items Enum: "lead.created" "lead.status_changed" "connection.accepted" "radar.connection_accepted" "radar.message_received" "job.completed" "job.failed" "job.canceled"
description
string
active
boolean

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{
  • "url": "http://example.com",
  • "events": [
    ],
  • "description": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Delete a webhook endpoint.

Delete a webhook endpoint.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Activate a webhook endpoint and clear failure state.

Activate a webhook endpoint and clear failure state.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Deactivate a webhook endpoint without deleting it.

Deactivate a webhook endpoint without deleting it.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Queue a test webhook delivery.

Queue a test webhook delivery.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Rotate a webhook signing secret.

Rotate a webhook signing secret.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Read recent webhook delivery attempts.

Read recent webhook delivery attempts.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer
query Parameters
page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Read one webhook delivery attempt with payload and response details.

Read one webhook delivery attempt with payload and response details.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer
delivery_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Queue a replay of a previous webhook delivery with the same event id.

Queue a replay of a previous webhook delivery with the same event id.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer
delivery_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Zapier

Polling triggers and REST hook subscriptions used by the Zapier connector.

Poll recently created leads, shaped for Zapier triggers.

Poll recently created leads, shaped for Zapier triggers.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Poll recently received messages, shaped for Zapier triggers.

Poll recently received messages, shaped for Zapier triggers.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Register a Zapier REST hook subscription.

Register a Zapier REST hook subscription.

Authorizations:
bearerApiKey
Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Remove a Zapier REST hook subscription.

Remove a Zapier REST hook subscription.

Authorizations:
bearerApiKey
path Parameters
webhook_id
required
integer

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Discovery

Machine-readable description of this API.

Public OpenAPI schema for the Yadulink Public API.

Public OpenAPI schema for the Yadulink Public API.

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

API keys

Key management from a signed-in Yadulink session. These back the Integrations console; an API key cannot manage keys.

List the API keys of the signed-in account. Used by the Integrations console.

List the API keys of the signed-in account. Used by the Integrations console.

Authorizations:
cookieAuth

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Create an API key from the signed-in account. The secret is returned once.

Create an API key from the signed-in account. The secret is returned once.

Authorizations:
cookieAuth
Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Rename an API key, change its scopes, or suspend and reactivate it.

Rename an API key, change its scopes, or suspend and reactivate it.

Authorizations:
cookieAuth
path Parameters
key_id
required
string
Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Revoke an API key permanently while keeping its usage history.

Revoke an API key permanently while keeping its usage history.

Authorizations:
cookieAuth
path Parameters
key_id
required
string

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Generate a new secret for an API key and invalidate the previous one.

Generate a new secret for an API key and invalidate the previous one.

Authorizations:
cookieAuth
path Parameters
key_id
required
string
Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Read request logs, aggregates and security events for one API key.

Read request logs, aggregates and security events for one API key.

Authorizations:
cookieAuth
path Parameters
key_id
required
string

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Prospect Radar

Internal Yadulink growth tooling. Documented so its calls are traceable, not offered as part of the customer contract; these operations require an internal account.

Read the Yadulink SaaS prospect radar scoring contract.

Read the Yadulink SaaS prospect radar scoring contract.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Read SaaS radar pipeline totals and configured LinkedIn accounts.

Read SaaS radar pipeline totals and configured LinkedIn accounts.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

List internal LinkedIn accounts configured for radar assignment.

List internal LinkedIn accounts configured for radar assignment.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Create or update an internal LinkedIn account for radar assignment.

Create or update an internal LinkedIn account for radar assignment.

Authorizations:
bearerApiKey
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Ingest sourced SaaS prospects and calculate server-side intent scores.

Ingest sourced SaaS prospects and calculate server-side intent scores.

Authorizations:
bearerApiKey
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Run a bounded read-only LinkedIn people search for radar discovery.

Run a bounded read-only LinkedIn people search for radar discovery.

Authorizations:
bearerApiKey
Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Resolve up to 20 exact public LinkedIn identifiers through a connected internal account.

Resolve up to 20 exact public LinkedIn identifiers through a connected internal account.

Authorizations:
bearerApiKey
Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

List scored SaaS radar candidates.

List scored SaaS radar candidates.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Claim the daily deduplicated prospect queue across active LinkedIn accounts.

Claim the daily deduplicated prospect queue across active LinkedIn accounts.

Authorizations:
bearerApiKey
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

List per-account radar lifecycle assignments.

List per-account radar lifecycle assignments.

Authorizations:
bearerApiKey

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Acknowledge radar assignments only after their daily digest was delivered.

Acknowledge radar assignments only after their daily digest was delivered.

Authorizations:
bearerApiKey
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Match Unipile sent invitations with profiles previously proposed by the radar.

Match Unipile sent invitations with profiles previously proposed by the radar.

Authorizations:
bearerApiKey
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Fetch pending invitations through Yadulink and match radar assignments without exposing Unipile credentials.

Fetch pending invitations through Yadulink and match radar assignments without exposing Unipile credentials.

Authorizations:
bearerApiKey
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Record a reviewed radar lifecycle transition without sending a LinkedIn action.

Record a reviewed radar lifecycle transition without sending a LinkedIn action.

Authorizations:
bearerApiKey
path Parameters
assignment_id
required
string
header Parameters
Idempotency-Key
string

Prevents duplicate side effects when retrying a request.

Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Enroll reviewed radar prospects into an outreach sequence.

Enroll reviewed radar prospects into an outreach sequence.

Authorizations:
bearerApiKey
Request Body schema: application/json
optional
property name*
additional property
any

Responses

Response Headers
X-Request-ID
string

Correlation id for this call, echoed on every response and stored with the API key usage log. Send your own value to keep it end to end; quote it to support.

Deprecation
string

Present only when this operation is scheduled for removal, per the published deprecation policy. (RFC 9745)

Sunset
string

Present only when this operation is scheduled for removal, per the published deprecation policy. Removal date as an HTTP-date (RFC 8594).

Response Schema: application/json
success
required
boolean
Value: true
object or array or null
object

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}