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 Custom Referral Statuses API

The Custom Referral Statuses API from FirstPromoter — 3 operation(s) for custom referral statuses.

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

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

This API exposes 3 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

3 operations 3 paths 4 schemas 1 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

FirstPromoter Custom Referral Statuses API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — API key passed as a Bearer token in the Authorization header. Found in Settings → Integrations → Manage API Keys.

Paths & Operations 3

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

Custom Referral Statuses 3
GET
/custom_referral_statuses
List custom referral statuses
1 param → 200401403
PUT
/custom_referral_statuses/update
Create, update, or delete custom referral statuses
1 param body → 200400401403422
PUT
/referrals/{id}
Set custom status on a referral
2 params body → 200401403404422

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CustomReferralStatus (7 properties), Referral (5 properties), Error (3 properties), Error_2 (2 properties). Each schema is shown below with its type and property counts.

CustomReferralStatus
object
7 properties
Error
object
3 properties
Error_2
object
2 properties
Referral
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firstpromoter-custom-referral-statuses-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 Dashboards API
FirstPromoter Email Settings API
FirstPromoter Emails API
FirstPromoter Invoice Templates API
Where this information came from

This is an independent, third-party profile of FirstPromoter Custom Referral Statuses 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.