TalkPush Leads API API is one of 14 APIs that TalkPush publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Leads API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
9 operations
across 9 paths,
and defines 10 schemas.
It is described by OpenAPI 3.0.0, at version 2.0.
Requests are made against a single base URL, https://company_subdomain.talkpush.com/api/talkpush_services.
9 operations9 paths10 schemas1 GET1 PATCH3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Across 9 paths, the API surfaces 9 operations — 1 GET, 1 PATCH, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Leads API 9
Collection of endpoints related to leads management
GET
/campaign_invitations
Retrieve a list of leads matching your search criterias
23 params→ 200500
PATCH
/campaign_invitations/{id}
Update a lead's details
2 paramsbody→ 200404500
POST
/campaigns/{id}/campaign_invitations
Create a new lead
2 paramsbody→ 200400404500
POST
/campaign_invitations/{id}/interview
Complete the interview for a candidate aplication
1 parambody→ 200400404500
POST
/campaign_invitations/{id}/comments
Create a comment for a lead
1 parambody→ 200400404500
PUT
/campaign_invitations/{id}/{status}
Change lead's status
4 params→ 200404500
PUT
/campaign_invitations/{id}/move
Move a lead to a different campaign
1 parambody→ 200400403404500
PUT
/campaign_invitations/{id}/reassign
Reassign a lead to another user
1 parambody→ 200400404500
PUT
/campaign_invitations/{id}/documents
Attach a document to a lead
4 paramsbody→ 200400404500
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are leads_response_candidates (22 properties), lead (7 properties), leads_response (4 properties), answer_body (3 properties). Each schema is shown below with its type and property counts.
interview_request
object
2 properties2 required
campaign_invitation_request
object
1 property1 required
lead
object
7 properties3 required
move_campaign_invitation_request
object
3 properties3 required
create_lead_request
object
2 properties2 required
leads_response_candidates
object
22 properties
leads_response
object
4 properties
reassign_request
object
2 properties2 required
answer_body
object
3 properties2 required
comments_request
object
3 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
