How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talon.One Referrals API

Represents a referral code shared between a customer (advocate) and a prospect (friend).A referral is defined by:- an advocate: person who invited their friend via referral program.- a friend: person who receives the invite from an advocate.- a referral code: code to be redeemed by the advocate(s) once they referred their friend.See the [docs](https://docs.talon.one/docs/product/campaigns/referrals/referral-overview).

Talon.One Referrals API is one of 42 APIs that Talon.One publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Referrals. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 8 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://yourbaseurl.talon.one.

8 operations 7 paths 16 schemas 1 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://yourbaseurl.talon.one
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Talon.One Referrals API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (api_key_v1). An API key is passed in the header as Authorization (manager_auth). An API key is passed in the header as Authorization (management_key).

  • api_key_v1 — To authenticate with the Integration API, generate an API key in the Campaign Manager and prefix it with ApiKey-v1. To generate an API key: 1. Sign in to the C…
  • manager_auth — This authentication scheme relies on a bearer token that you can use to access all the endpoints of the Management API. To create the token: 1. Get a bearer to…
  • management_key — The API key authentication gives you access to the endpoints selected by the admin who created the key. Using an API key is the recommended authentication meth…

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Referrals 8

Represents a referral code shared between a customer (advocate) and a prospect (friend). A referral is defined by: - an advocate: person who invited their friend via referral prog…

POST
/v1/referrals
Create referral code for an advocate
createReferral body → 201400401
POST
/v1/referrals_for_multiple_advocates
Create referral codes for multiple advocates
createReferralsForMultipleAdvocates 1 param body → 201204400401
DELETE
/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}
Delete referral
deleteReferral 3 params → 204
PUT
/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}
Update referral
updateReferral 3 params body → 200
GET
/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total
List referrals
getReferralsWithoutTotalCount 11 params → 200
GET
/v1/applications/{applicationId}/profile/{integrationId}/friends
List friends referred by customer profile
getApplicationCustomerFriends 6 params → 200
GET
/v1/applications/{applicationId}/export_referrals
Export referrals
exportReferrals 8 params → 200
POST
/v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals
Import referrals
importReferrals 2 params body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are UpdateReferral (5 properties), ErrorSource (4 properties), ReferralConstraints (3 properties), APIError (3 properties). Each schema is shown below with its type and property counts.

ErrorResponseWithStatus
object
3 properties
APIError
object
3 properties 2 required
ErrorResponse
object
2 properties 1 required
NewReferral
Referral
Entity
object
2 properties 2 required
ImportEntity
object
1 property
NewReferralsForMultipleAdvocates
ErrorSource
object
The source of the current error, exactly one of pointer, parameter or line will be defined.
4 properties
ReferralConstraints
object
3 properties
ApplicationReferee
AccountEntity
object
1 property 1 required
UpdateReferral
object
5 properties
UserEntity
object
1 property 1 required
Import
ApplicationEntity
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talon-one-referrals-api-openapi.yml Raw ↑

Other APIs Talon.One publishes across the network.

Talon.One Accounts and users API
Talon.One Achievements API
Talon.One Additional costs API
Talon.One Analytics API
Talon.One Applications API
Talon.One Attributes API
Talon.One Audiences API
Talon.One Braze API
Talon.One Campaign access groups API
Talon.One Campaign notifications API
Talon.One Campaign templates API
Talon.One Campaigns API
Where this information came from

This is an independent, third-party profile of Talon.One Referrals API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.