Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talkable Origins API

The Origins API from Talkable — 8 operation(s) for origins.

Talkable Origins API is one of 26 APIs that Talkable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Origins. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 8 operations across 8 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://www.talkable.com.

8 operations 8 paths 4 schemas 8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://www.talkable.com/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Talkable Origins API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (api_key). By default, every request must be authenticated.

  • api_key — Please provide here your API key, you can find it in Site Settings - API Integration - API Key

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 POST. Each is listed below with its method, path, parameters, and response codes.

Origins 8
POST
/api/v2/origins
Create an origin
createOrigin body → 201400
POST
/api/v2/origins/affiliate_member
Create an affiliate member
createAffiliateMember body → 201400
POST
/api/v2/origins/event
Create an event
createEvent body → 201400
POST
/api/v2/origins/purchase
Create a purchase
createPurchase body → 201400
POST
/api/v2/origins/batch/affiliate_members
Create batch of affiliate members
createBatchOfAffiliateMembers body → 200
POST
/api/v2/origins/batch/events
Create batch of events
createBatchOfEvents body → 200
POST
/api/v2/origins/batch/purchases
Create batch of purchases
createBatchOfPurchases body → 200
POST
/api/v2/origins/{origin_slug}/refund
Mark origin as refunded
markOriginAsRefunded 1 param body → 200400

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

coupon_codes
array
origin_slug
string
If origin is a Purchase: ordernumber, e.g.: "B00K2EOONI" If origin is an Event: eventcategory:eventnumber, e.g.: "newslettersubscription:42"
currency_code
string
Required for multi-currency sites
visitor_uuid
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talkable-origins-api-openapi.yml Raw ↑

Other APIs Talkable publishes across the network.

Talkable Advocate Offers API
Talkable Advocate Signup API
Talkable Assets API
Talkable Campaigns API
Talkable Check Unsubscribe API
Talkable Claim Links API
Talkable Coupons API
Talkable Create Coupon API
Talkable Event API
Talkable Friend Email Gating API
Talkable Friend Offers API
Talkable Loyalty API