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

FirstPromoter Promoter Campaigns API

The Promoter Campaigns API from FirstPromoter — 5 operation(s) for promoter campaigns.

FirstPromoter Promoter Campaigns API is one of 30 APIs that FirstPromoter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Promoter Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.firstpromoter.com/api/v2/affiliate, https://api.firstpromoter.com/api/v2/company.

5 operations 5 paths 10 schemas 4 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.firstpromoter.com/api/v2/company
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

FirstPromoter Promoter Campaigns API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as ACCOUNT-ID (accountId). By default, every request must be authenticated.

  • BearerAuth — Access token passed as a Bearer token in the Authorization header
  • accountId — Account ID required with bearer token

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 4 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Promoter Campaigns 5
PUT
/promoter_campaigns/{id}
Update promotion reftoken for the promotercampaign
2 params body → 200401403404422
GET
/promoter_campaigns
Get available promoter campaigns
1 param → 200401403
GET
/promoter_campaigns/search
Returns results for promoter campaigns dropdown search. Max results: 5
2 params → 200401403
GET
/promoter_campaigns/{id}/referral_links
Get promoter campaign referral links
getReferralLinksAssociatedWithThisPromoterCampaign 2 params → 200401403404
GET
/promoter_campaigns/{id}/chart_data
Get data used for chart
getPromoterCampaignChartData 6 params → 200401403404422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PromoterCampaign_2 (19 properties), PromoterCampaign (17 properties), ReferralLink (7 properties), ChartData (5 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
PromoterCampaign
object
17 properties
Promoter
object
3 properties
Error_2
object
3 properties 2 required
Campaign
object
3 properties
ReferralLink
object
7 properties
ChartData
object
5 properties
RewardConfig
object
3 properties 3 required
Reward
object
5 properties
PromoterCampaign_2
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firstpromoter-promoter-campaigns-api-openapi.yml Raw ↑

Other APIs FirstPromoter publishes across the network.

FirstPromoter Asset Categories API
FirstPromoter Assets API
FirstPromoter Batch Processes API
FirstPromoter Campaigns API
FirstPromoter Cancellation API
FirstPromoter Commissions API
FirstPromoter Contract Documents API
FirstPromoter Contracts API
FirstPromoter Custom Referral Statuses API
FirstPromoter Dashboards API
FirstPromoter Email Settings API
FirstPromoter Emails API
Where this information came from

This is an independent, third-party profile of FirstPromoter Promoter Campaigns 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.