Transférer un prospect

Lorsqu'un prospect existe au sein d'une chaîne de clubs, celui-ci est lié à son club d'origine. La documentation ci-après explique le process de migration de prospect permettant une mobilité contrôlée des prospects au sein d'une chaîne de clubs.

Le principe de migration

Une fiche prospect étant la propriété d'un club A, si ce même prospect souhaite aller dans le club B il initiera un processus de migration. Du point de vu du prospect ce processus consiste à:

• Initier une demande de migration
• Recevoir un code de confirmation par SMS
• saisir le code de confirmation

Initier la migration

La migration de prospect passe donc par l'envoi d'un SMS au contact qui contient un code à utiliser à l'étape suivante.

POST /{clientToken}/contact_migration_requests

paramètre	description	exemple
clubId	Identifiant du club sous forme d'IRI	/{clientToken}/clubs/1
contactId	Identifiant du prospect ciblé par la migration. Il s'agit d'une IRI et non d'un simple identifiant numérique	/{clientToken}/contacts/12345

Exemple

POST /{clientToken}/contact_migration_requests

Body

{
    "clubId": "/{clientToken}/clubs/22",
    "contactId": "/{clientToken}/contacts/1"
}

Réponse 201 Created

{  
   "@context":"\/clientToken\/contexts\/SignatureRequest",
   "@id":"\/clientToken\/signature_requests\/455434",        <-------- Identifiant de demande de migration
   "@type":"SignatureRequest",
  // ...
}

Terminer le processus de migration

Une fois le SMS reçu l'application souhaitant orchestrer la migration devra récolter le code en provenance du contact ciblé et terminer le processus de signature en validant ce code.

POST /{clientToken}/signature_requests/{signatureRequestId}/transitions

paramètre	description	exemple
signatureRequestId	Identifiant du processus de signature créé précédemment	3451
transition	Type de transition souhaitée. Les valeurs possibles sont validate ou cancel	validate
code	Code de validation reçu par SMS	1234

Exemple

POST /{clientToken}/signature_requests/455434/transitions

Body

{
    "transition": "validate",
    "code": "94852"
}

Réponse 201 Created

Erreurs référencées

400 : Bad Request La ressource \"/{clientToken}/contacts/{id}\" n'existe pas.

Cela est en relation avec la notion de partage de données entre clubs configurée au sein d'une chaîne. Vous opérez actuellement pour un club qui n'a pas les droits nécessaires pour atteindre la fiche de contact à migrer.

Solution: Si vous êtes connecté en client_credentials et spécifiez les headers de noeud, opérez depuis un niveau supérieur au noeud du club.

400 : Bad Request api.error.contact.migration.club-not-valid

Le club cible n'est pas valie. Cela se produit lorsque l'on demande une migration vers le club actuel du contact.

Solution: Revoyez la cible.

400 : Bad Request api.error.contact.migration.contact-not-valid

Le contact n'est pas transférable. Cela se produit si le statut du contact n'est ni prospect, ni ancien client.

Solution: Revoyez le contact.