Skip to Content
FanConvert Docs
Reference

Fans

Reference generated from the OpenAPI contract: Fans.

6 min readOpen in ChatGPTOpen in Claude

Les étiquettes de fans d'une créatrice

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

Parameters

NameInTypeRequiredDescription
creator_idpathstringyesIdentifiant de la créatrice.
platformquery"mym" | "telegram"noLa plateforme du fan. (default : mym)

Response 200

Page_FanLabel_

FieldTypeRequiredDescription
itemsFanLabel[]yes
nextCursorstring | nullnoÀ repasser en cursor pour lire la page suivante ; null = dernière page.

FanLabel

FieldTypeRequiredDescription
idstringyes
namestringyes
colorstringyes

Possible errors

401 · 403 · 404 · 422 · 429 · 503 — Error format: Errors.

Example

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

Parameters

NameInTypeRequiredDescription
creator_idpathstringyesIdentifiant de la créatrice.
conversation_idpathstringyesIdentifiant de la conversation.
platformquery"mym" | "telegram"noLa plateforme du fan. (default : mym)

Response 200

FanCard

FieldTypeRequiredDescription
conversationIdstringyes
platform"mym" | "telegram"yes
labelsFanLabel[]yes
noteTeamNoteyes

FanLabel

FieldTypeRequiredDescription
idstringyes
namestringyes
colorstringyes

TeamNote

FieldTypeRequiredDescription
textstring | nullyes
revisionintegeryesÀ renvoyer en expectedRevision pour écrire.
updatedAtstring (date-time) | nullyes

Possible errors

401 · 403 · 404 · 422 · 429 · 503 — Error format: Errors.

Example

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

Parameters

NameInTypeRequiredDescription
creator_idpathstringyesIdentifiant de la créatrice.
conversation_idpathstringyesIdentifiant de la conversation.
platformquery"mym" | "telegram"noLa plateforme du fan. (default : mym)

Request body

TeamNoteWrite

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

Response 200

FanCard

FieldTypeRequiredDescription
conversationIdstringyes
platform"mym" | "telegram"yes
labelsFanLabel[]yes
noteTeamNoteyes

FanLabel

FieldTypeRequiredDescription
idstringyes
namestringyes
colorstringyes

TeamNote

FieldTypeRequiredDescription
textstring | nullyes
revisionintegeryesÀ renvoyer en expectedRevision pour écrire.
updatedAtstring (date-time) | nullyes

Possible errors

401 · 403 · 404 · 409 · 422 · 429 · 503 — Error format: Errors.

Example

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

Parameters

NameInTypeRequiredDescription
creator_idpathstringyesIdentifiant de la créatrice.
conversation_idpathstringyesIdentifiant de la conversation.
label_idpathstringyesIdentifiant de l'étiquette.
platformquery"mym" | "telegram"noLa plateforme du fan. (default : mym)

Response 200

FanCard

FieldTypeRequiredDescription
conversationIdstringyes
platform"mym" | "telegram"yes
labelsFanLabel[]yes
noteTeamNoteyes

FanLabel

FieldTypeRequiredDescription
idstringyes
namestringyes
colorstringyes

TeamNote

FieldTypeRequiredDescription
textstring | nullyes
revisionintegeryesÀ renvoyer en expectedRevision pour écrire.
updatedAtstring (date-time) | nullyes

Possible errors

401 · 403 · 404 · 409 · 422 · 429 · 503 — Error format: Errors.

Example

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

Parameters

NameInTypeRequiredDescription
creator_idpathstringyesIdentifiant de la créatrice.
conversation_idpathstringyesIdentifiant de la conversation.
label_idpathstringyesIdentifiant de l'étiquette.
platformquery"mym" | "telegram"noLa plateforme du fan. (default : mym)

Response 200

FanCard

FieldTypeRequiredDescription
conversationIdstringyes
platform"mym" | "telegram"yes
labelsFanLabel[]yes
noteTeamNoteyes

FanLabel

FieldTypeRequiredDescription
idstringyes
namestringyes
colorstringyes

TeamNote

FieldTypeRequiredDescription
textstring | nullyes
revisionintegeryesÀ renvoyer en expectedRevision pour écrire.
updatedAtstring (date-time) | nullyes

Possible errors

401 · 403 · 404 · 409 · 422 · 429 · 503 — Error format: Errors.

Example

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

Last updated on

Conversations

Reference generated from the OpenAPI contract: Conversations.

AI

Reference generated from the OpenAPI contract: AI.

On this page

Les étiquettes de fans d'une créatriceParametersResponse 200Possible errorsExampleLa fiche d'un fan : étiquettes et note de l'équipeParametersResponse 200Possible errorsExampleÉcrire la note de l'équipe sur un fanParametersRequest bodyResponse 200Possible errorsExamplePoser une étiquette sur un fan (sans effet si elle y est déjà)ParametersResponse 200Possible errorsExampleRetirer une étiquette d'un fanParametersResponse 200Possible errorsExample