TalkPush Campaigns 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 Campaigns API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
11 operations
across 9 paths,
and defines 5 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.
11 operations9 paths5 schemas6 GET2 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Across 9 paths, the API surfaces 11 operations — 6 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Campaigns API 11
Collection of endpoints related to Talkpush Campaigns
GET
/campaigns
Retrieve all active campaigns of the account
2 params→ 200404500
POST
/campaigns
Create a new campaign inside your Talkpush account
body→ 200400404500
GET
/campaigns/archive
Retrieve all archive campaigns of the account
1 param→ 200404500
GET
/campaigns/search/{criteria}
Retrieve details of active campaigns that match the search criteria
2 params→ 200404500
GET
/campaigns/{id}
Retrieve details of a specific active campaign
2 params→ 200404500
PUT
/campaigns/{id}
Update a campaign inside your Talkpush account
1 parambody→ 200404500
GET
/campaigns/{id}/questions
Get questions for a specific campaign
2 params→ 200404500
GET
/campaigns/{id}/folders
Retrieve all the folders that are associated to a campaign
2 params→ 200500
PUT
/campaigns/{id}/archive
Archive an existing campaign
2 params→ 200404500
PUT
/campaigns/{id}/activate
Activate an archived campaign
2 params→ 200404500
POST
/campaigns/{campaign_id}/folders/{folder_id}
Associate a campaign with a custom folder
3 params→ 200404500
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are campaign_response_body (25 properties), campaign (20 properties), question_body (5 properties), folder_body (3 properties). Each schema is shown below with its type and property counts.
folder_body
object
3 properties3 required
question_body
object
5 properties
campaigns_response
object
1 property
campaign_response_body
object
25 properties
campaign
object
20 properties7 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
