Skip to main content
Une demande d’attribution ne prend effet que lorsqu’un propriétaire de l’entreprise l’accepte. Utilisez l’API Partner Referral Requests pour créer des liens de parrainage et envoyer des demandes d’attribution. Vous pouvez également lister les liens et demandes que vous avez envoyés ou reçus, et accepter, refuser ou annuler une demande en attente.

Endpoints

Attributs

string
requis
ID de la demande de parrainage partenaire, préfixé par prfr_.
object | null
requis
Entreprise qui reçoit la demande, lorsqu’une entreprise est assignée.

Propriétés

string
requis
ID du compte, préfixé par biz_.
string
requis
Nom d’affichage du compte.
string | null
requis
L’appartenance à l’équipe du partenaire pour laquelle ce parrainage a été créé, préfixée par ausr_. null lorsque le parrainage est personnel.
string | null
requis
Code de parrainage unique, lorsqu’il est attribué.
string
requis
Date de création de la demande, sous forme d’horodatage ISO 8601.
integer | null
requis
Nombre maximal d’utilisations autorisées, lorsqu’il est limité.
string | null
requis
La fiche membre du partenaire pour laquelle ce parrainage a été créé, préfixée par mber_, lorsque son rôle dans cette entreprise est rattaché à sa fiche membre. null dans le cas contraire.
object
requis
Profil public du partenaire à l’origine de la demande.

Propriétés

string
requis
ID de l’utilisateur, préfixé par user_.
string | null
requis
Nom d’affichage.
object
requis
Conteneur de l’avatar. Son url est toujours présent, et correspond à une image générée par défaut lorsque l’utilisateur n’a défini aucune photo.

Propriétés

string
requis
URL de l’image de l’avatar. Toujours présente. Il s’agit d’une image générée par défaut lorsque l’utilisateur n’a défini aucune photo.
string
requis
Nom d’utilisateur public.
object | null
requis
Entreprise au nom de laquelle le partenaire a envoyé cette demande, lorsque le parrainage appartient à son équipe. null pour un parrainage personnel.

Propriétés

string
requis
ID du compte, préfixé par biz_.
string
requis
Nom d’affichage du compte.
string
requis
La manière dont la demande de parrainage a été initiée.Options disponibles : manual, ownership_transfer, link
object[]
requis
Récompenses proposées par cette demande.

Propriétés

string
requis
ID de la récompense partenaire, préfixé par prwd_.
string | null
requis
Activité qui donne droit à cette récompense, lorsqu’elle est spécifiée.Options disponibles : sales, ad_spend
object
requis
Montant en USD de l’activité éligible requis pour obtenir la récompense.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string | null
requis
Rôle du bénéficiaire de la récompense, ou null pour un utilisateur fixe qui n’est pas le partenaire à l’origine de la demande.Options disponibles : business, partner
string | null
requis
ID de l’utilisateur ou de l’entreprise bénéficiaire concret, ou null jusqu’à ce qu’une entreprise utilise l’offre.
object
requis
Montant en USD accordé une fois les conditions remplies.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string | null
requis
L’état d’approbation, ou null pour les demandes sans processus d’approbation.Options disponibles : pending, accepted, denied, cancelled
string
requis
Date de dernière modification de la demande, sous forme d’horodatage ISO 8601.
object | null
requis
L’utilisateur auquel une demande d’attribution a été envoyée. Obsolète : les demandes adressées à un utilisateur ont pris fin. Toujours null. OBSOLÈTE : n’est plus renseigné. Toujours null.

Propriétés

string
requis
ID de l’utilisateur, préfixé par user_.
string | null
requis
Nom d’affichage.
object
requis
Conteneur de l’avatar. Son url est toujours présent, et correspond à une image générée par défaut lorsque l’utilisateur n’a défini aucune photo.

Propriétés

string
requis
URL de l’image de l’avatar. Toujours présente. Il s’agit d’une image générée par défaut lorsque l’utilisateur n’a défini aucune photo.
string
requis
Nom d’utilisateur public.
PartnerReferralRequest