Aller au contenu
FanConvert Docs
Référence

Fans

Référence générée depuis le contrat OpenAPI : Fans.

6 min de lectureOuvrir dans ChatGPTOuvrir dans Claude

Les étiquettes de fans d'une créatrice

GET /public/v1/creators/{creator_id}/labels · listFanLabels

Paramètres

NomOùTypeRequisDescription
creator_idcheminstringouiIdentifiant de la créatrice.
platformrequête"mym" | "telegram"nonLa plateforme du fan. (défaut : mym)

Réponse 200

Page_FanLabel_

ChampTypeRequisDescription
itemsFanLabel[]oui
nextCursorstring | nullnonÀ repasser en cursor pour lire la page suivante ; null = dernière page.

FanLabel

ChampTypeRequisDescription
idstringoui
namestringoui
colorstringoui

Erreurs possibles

401 · 403 · 404 · 422 · 429 · 503 — Format des erreurs : Erreurs.

Exemple

curl -X GET "https://app.fanconvert.ai/public/v1/creators/{creator_id}/labels" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY"

La fiche d'un fan : étiquettes et note de l'équipe

GET /public/v1/creators/{creator_id}/fans/{conversation_id} · getFan

Paramètres

NomOùTypeRequisDescription
creator_idcheminstringouiIdentifiant de la créatrice.
conversation_idcheminstringouiIdentifiant de la conversation.
platformrequête"mym" | "telegram"nonLa plateforme du fan. (défaut : mym)

Réponse 200

FanCard

ChampTypeRequisDescription
conversationIdstringoui
platform"mym" | "telegram"oui
labelsFanLabel[]oui
noteTeamNoteoui

FanLabel

ChampTypeRequisDescription
idstringoui
namestringoui
colorstringoui

TeamNote

ChampTypeRequisDescription
textstring | nulloui
revisionintegerouiÀ renvoyer en expectedRevision pour écrire.
updatedAtstring (date-time) | nulloui

Erreurs possibles

401 · 403 · 404 · 422 · 429 · 503 — Format des erreurs : Erreurs.

Exemple

curl -X GET "https://app.fanconvert.ai/public/v1/creators/{creator_id}/fans/{conversation_id}" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY"

Écrire la note de l'équipe sur un fan

PUT /public/v1/creators/{creator_id}/fans/{conversation_id}/note · putFanNote

Paramètres

NomOùTypeRequisDescription
creator_idcheminstringouiIdentifiant de la créatrice.
conversation_idcheminstringouiIdentifiant de la conversation.
platformrequête"mym" | "telegram"nonLa plateforme du fan. (défaut : mym)

Corps de la requête

TeamNoteWrite

ChampTypeRequisDescription
textstringouiLa note, 1 000 caractères au plus ; vide = retirée.
expectedRevisionintegerouiLa revision lue : une autre écriture entre-temps → 409.

Réponse 200

FanCard

ChampTypeRequisDescription
conversationIdstringoui
platform"mym" | "telegram"oui
labelsFanLabel[]oui
noteTeamNoteoui

FanLabel

ChampTypeRequisDescription
idstringoui
namestringoui
colorstringoui

TeamNote

ChampTypeRequisDescription
textstring | nulloui
revisionintegerouiÀ renvoyer en expectedRevision pour écrire.
updatedAtstring (date-time) | nulloui

Erreurs possibles

401 · 403 · 404 · 409 · 422 · 429 · 503 — Format des erreurs : Erreurs.

Exemple

curl -X PUT "https://app.fanconvert.ai/public/v1/creators/{creator_id}/fans/{conversation_id}/note" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Poser une étiquette sur un fan (sans effet si elle y est déjà)

PUT /public/v1/creators/{creator_id}/fans/{conversation_id}/labels/{label_id} · addFanLabel

Paramètres

NomOùTypeRequisDescription
creator_idcheminstringouiIdentifiant de la créatrice.
conversation_idcheminstringouiIdentifiant de la conversation.
label_idcheminstringouiIdentifiant de l'étiquette.
platformrequête"mym" | "telegram"nonLa plateforme du fan. (défaut : mym)

Réponse 200

FanCard

ChampTypeRequisDescription
conversationIdstringoui
platform"mym" | "telegram"oui
labelsFanLabel[]oui
noteTeamNoteoui

FanLabel

ChampTypeRequisDescription
idstringoui
namestringoui
colorstringoui

TeamNote

ChampTypeRequisDescription
textstring | nulloui
revisionintegerouiÀ renvoyer en expectedRevision pour écrire.
updatedAtstring (date-time) | nulloui

Erreurs possibles

401 · 403 · 404 · 409 · 422 · 429 · 503 — Format des erreurs : Erreurs.

Exemple

curl -X PUT "https://app.fanconvert.ai/public/v1/creators/{creator_id}/fans/{conversation_id}/labels/{label_id}" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY"

Retirer une étiquette d'un fan

DELETE /public/v1/creators/{creator_id}/fans/{conversation_id}/labels/{label_id} · removeFanLabel

Paramètres

NomOùTypeRequisDescription
creator_idcheminstringouiIdentifiant de la créatrice.
conversation_idcheminstringouiIdentifiant de la conversation.
label_idcheminstringouiIdentifiant de l'étiquette.
platformrequête"mym" | "telegram"nonLa plateforme du fan. (défaut : mym)

Réponse 200

FanCard

ChampTypeRequisDescription
conversationIdstringoui
platform"mym" | "telegram"oui
labelsFanLabel[]oui
noteTeamNoteoui

FanLabel

ChampTypeRequisDescription
idstringoui
namestringoui
colorstringoui

TeamNote

ChampTypeRequisDescription
textstring | nulloui
revisionintegerouiÀ renvoyer en expectedRevision pour écrire.
updatedAtstring (date-time) | nulloui

Erreurs possibles

401 · 403 · 404 · 409 · 422 · 429 · 503 — Format des erreurs : Erreurs.

Exemple

curl -X DELETE "https://app.fanconvert.ai/public/v1/creators/{creator_id}/fans/{conversation_id}/labels/{label_id}" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY"

Mis à jour le

Conversations

Référence générée depuis le contrat OpenAPI : Conversations.

IA

Référence générée depuis le contrat OpenAPI : IA.

Sur cette page

Les étiquettes de fans d'une créatriceParamètresRéponse 200Erreurs possiblesExempleLa fiche d'un fan : étiquettes et note de l'équipeParamètresRéponse 200Erreurs possiblesExempleÉcrire la note de l'équipe sur un fanParamètresCorps de la requêteRéponse 200Erreurs possiblesExemplePoser une étiquette sur un fan (sans effet si elle y est déjà)ParamètresRéponse 200Erreurs possiblesExempleRetirer une étiquette d'un fanParamètresRéponse 200Erreurs possiblesExemple