Recherche dans la base de connaissances

Prospects

Prospects

Prospect - Ajouter un nouveau prospect

POST votredomaine.com/api/leads

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

source

String

Source de plomb obligatoire.

status

String

Status de prospect obligatoire.

name

String

Nom du prospect obligatoire.

assigned (facultatif)

String

Lead facultatif attribué.

client_id (facultatif)

String

Lead facultatif du client.

tags (facultatif)

String

Balises de prospect facultatives.

contact (facultatif)

String

Contact principal facultatif.

title (facultatif)

String

Poste optionnel.

email (facultatif)

String

Adresse e-mail facultative du prospect.

website (facultatif)

String

Site Web principal facultatif.

phonenumber (facultatif)

String

Téléphone principal facultatif.

company (facultatif)

String

Entreprise principale facultative.

address (facultatif)

String

Adresse du prospect facultative.

city (facultatif)

String

Ville principale facultative.

state (facultatif)

String

État de plomb facultatif.

country (facultatif)

String

Pays pilote facultatif.

default_language (facultatif)

String

Langue facultative par défaut de la piste.

description (facultatif)

String

Description facultative du prospect.

custom_contact_date (facultatif)

String

Lead facultatif du client.

contacted_today (facultatif)

String

Lead facultatif contacté aujourd'hui.

is_public (facultatif)

String

Identifiant de feuille Google principal facultatif.

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande.

message

String

Ajout réussi.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

ajouter un échec.

  • Réponse réussie

HTTP/1.1 200 OK{ "status": true, "message": "Lead add successful."}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{ "status": false, "message": "Lead add fail."}

Piste - Supprimer une piste

SUPPRIMER votredomaine.com/api/delete/leads/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

id

Number

identifiant unique du prospect.

Succès 200

json

Champ

Type

Description

status

String

État de la demande.

message

String

Suppression réussie du prospect.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Échec de la suppression du prospect.

  • Réponse réussie

HTTP/1.1 200 OK{ "status": true, "message": "Lead Delete Successful."}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{ "status": false, "message": "Lead Delete Fail."}

Prospect - Demander des informations sur le prospect

OBTENEZ votredomaine.com/api/leads/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

id

Number

Identifiant unique du prospect.

Succès 200

json

Champ

Type

Description

Mener

Objet

information.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Aucune donnée n'a été trouvée.

  • Réponse réussie

HTTP/1.1 200 OK
{
"id": "17",
"hash": "c6e938f8b7a40b1bcfd98dc04f6eeee0-60d9c039da373a685fc0f74d4bfae631",
"name": "Lead name",
"contact": "",
"title": "",
"company": "Themesic Interactive",
"description": "",
"country": "243",
"zip": null,
"city": "London",
"state": "London",
"address": "1a The Alexander Suite Silk Point",
"assigned": "5",
"dateadded": "2019-07-18 08:59:28",
"from_form_id": "0",
"status": "0",
"source": "4",
...
}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{ "status": false, "message": "No data were found"}

Prospect - Rechercher des informations sur le prospect

OBTENEZ votredomaine.com/api/leads/search/:keysearch

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

keysearch clé

String

Rechercher des mots-clés.

Succès 200

json

Champ

Type

Description

Lead

Objet

information.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Aucune donnée n'a été trouvée.

  • Réponse réussie

HTTP/1.1 200 OK
{
"id": "17",
"hash": "c6e938f8b7a40b1bcfd98dc04f6eeee0-60d9c039da373a685fc0f74d4bfae631",
"name": "Lead name",
"contact": "",
"title": "",
"company": "Themesic Interactive",
"description": "",
"country": "243",
"zip": null,
"city": "London",
"state": "London",
"address": "1a The Alexander Suite Silk Point",
"assigned": "5",
"dateadded": "2019-07-18 08:59:28",
"from_form_id": "0",
"status": "0",
"source": "4",
...
}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{ "status": false, "message": "No data were found"}

Prospect - Mettre à jour un prospect

PUT votredomaine.com/api/leads/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

source

String

Source de plomb obligatoire.

status

String

Status de prospect obligatoire.

name

String

Nom du prospect obligatoire.

assigned (facultatif)

String

Lead facultatif attribué.

client_id (facultatif)

String

Lead facultatif du client.

tags (facultatif)

String

Balises de prospect facultatives.

contact (facultatif)

String

Contact principal facultatif.

title (facultatif)

String

Poste optionnel.

email (facultatif)

String

Adresse e-mail facultative du prospect.

website (facultatif)

String

Site Web principal facultatif.

phonenumber (facultatif)

String

Téléphone principal facultatif.

company (facultatif)

String

Entreprise principale facultative.

address (facultatif)

String

Adresse du prospect facultative.

city (facultatif)

String

Ville principale facultative.

state (facultatif)

String

État de plomb facultatif.

country (facultatif)

String

Pays pilote facultatif.

default_language (facultatif)

String

Langue facultative par défaut de la piste.

description (facultatif)

String

Description facultative du prospect.

lastcontact (facultatif)

String

Dernier contact du prospect facultatif.

is_public (facultatif)

String

Identifiant de feuille Google principal facultatif.

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande.

message

String

Mise à jour du prospect réussie.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Échec de la mise à jour de la piste.

Prospects

Prospect - Ajouter un nouveau prospect

POST votredomaine.com/api/leads

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

source

String

Source de plomb obligatoire.

status

String

Status de prospect obligatoire.

name

String

Nom du prospect obligatoire.

assigned (facultatif)

String

Lead facultatif attribué.

client_id (facultatif)

String

Lead facultatif du client.

tags (facultatif)

String

Balises de prospect facultatives.

contact (facultatif)

String

Contact principal facultatif.

title (facultatif)

String

Poste optionnel.

email (facultatif)

String

Adresse e-mail facultative du prospect.

website (facultatif)

String

Site Web principal facultatif.

phonenumber (facultatif)

String

Téléphone principal facultatif.

company (facultatif)

String

Entreprise principale facultative.

address (facultatif)

String

Adresse du prospect facultative.

city (facultatif)

String

Ville principale facultative.

state (facultatif)

String

État de plomb facultatif.

country (facultatif)

String

Pays pilote facultatif.

default_language (facultatif)

String

Langue facultative par défaut de la piste.

description (facultatif)

String

Description facultative du prospect.

custom_contact_date (facultatif)

String

Lead facultatif du client.

contacted_today (facultatif)

String

Lead facultatif contacté aujourd'hui.

is_public (facultatif)

String

Identifiant de feuille Google principal facultatif.

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande.

message

String

Ajout réussi.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

ajouter un échec.
  • Réponse réussie

HTTP/1.1 200 OK{ "status": true, "message": "Lead add successful."}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{ "status": false, "message": "Lead add fail."}

Piste - Supprimer une piste

SUPPRIMER votredomaine.com/api/delete/leads/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

id

Number

identifiant unique du prospect.

Succès 200

json

Champ

Type

Description

status

String

État de la demande.

message

String

Suppression réussie du prospect.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Échec de la suppression du prospect.
  • Réponse réussie

HTTP/1.1 200 OK{ "status": true, "message": "Lead Delete Successful."}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{ "status": false, "message": "Lead Delete Fail."}

Prospect - Demander des informations sur le prospect

OBTENEZ votredomaine.com/api/leads/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

id

Number

Identifiant unique du prospect.

Succès 200

json

Champ

Type

Description

Mener

Objet

information.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Aucune donnée n'a été trouvée.
  • Réponse réussie

HTTP/1.1 200 OK
{
"id": "17",
"hash": "c6e938f8b7a40b1bcfd98dc04f6eeee0-60d9c039da373a685fc0f74d4bfae631",
"name": "Lead name",
"contact": "",
"title": "",
"company": "Themesic Interactive",
"description": "",
"country": "243",
"zip": null,
"city": "London",
"state": "London",
"address": "1a The Alexander Suite Silk Point",
"assigned": "5",
"dateadded": "2019-07-18 08:59:28",
"from_form_id": "0",
"status": "0",
"source": "4",
...
}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{ "status": false, "message": "No data were found"}

Prospect - Rechercher des informations sur le prospect

OBTENEZ votredomaine.com/api/leads/search/:keysearch

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

keysearch clé

String

Rechercher des mots-clés.

Succès 200

json

Champ

Type

Description

Lead

Objet

information.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Aucune donnée n'a été trouvée.
  • Réponse réussie

HTTP/1.1 200 OK
{
"id": "17",
"hash": "c6e938f8b7a40b1bcfd98dc04f6eeee0-60d9c039da373a685fc0f74d4bfae631",
"name": "Lead name",
"contact": "",
"title": "",
"company": "Themesic Interactive",
"description": "",
"country": "243",
"zip": null,
"city": "London",
"state": "London",
"address": "1a The Alexander Suite Silk Point",
"assigned": "5",
"dateadded": "2019-07-18 08:59:28",
"from_form_id": "0",
"status": "0",
"source": "4",
...
}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{ "status": false, "message": "No data were found"}

Prospect - Mettre à jour un prospect

PUT votredomaine.com/api/leads/:id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base.

Paramètre

json

Champ

Type

Description

source

String

Source de plomb obligatoire.

status

String

Status de prospect obligatoire.

name

String

Nom du prospect obligatoire.

assigned (facultatif)

String

Lead facultatif attribué.

client_id (facultatif)

String

Lead facultatif du client.

tags (facultatif)

String

Balises de prospect facultatives.

contact (facultatif)

String

Contact principal facultatif.

title (facultatif)

String

Poste optionnel.

email (facultatif)

String

Adresse e-mail facultative du prospect.

website (facultatif)

String

Site Web principal facultatif.

phonenumber (facultatif)

String

Téléphone principal facultatif.

company (facultatif)

String

Entreprise principale facultative.

address (facultatif)

String

Adresse du prospect facultative.

city (facultatif)

String

Ville principale facultative.

state (facultatif)

String

État de plomb facultatif.

country (facultatif)

String

Pays pilote facultatif.

default_language (facultatif)

String

Langue facultative par défaut de la piste.

description (facultatif)

String

Description facultative du prospect.

lastcontact (facultatif)

String

Dernier contact du prospect facultatif.

is_public (facultatif)

String

Identifiant de feuille Google principal facultatif.

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande.

message

String

Mise à jour du prospect réussie.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande.

message

String

Échec de la mise à jour de la piste.
  • Réponse réussie

HTTP/1.1 200 OK{ "status": true, "message": "Lead Update Successful."}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{ "status": false, "message": "Lead Update Fail."}

  • Réponse réussie

HTTP/1.1 200 OK{ "status": true, "message": "Lead Update Successful."}

  • Réponse d’erreur

HTTP/1.1 404 Not Found{ "status": false, "message": "Lead Update Fail."}

Avez-vous trouvé cet article utile ?

Articles associés

  • Introduction

    API REST GlueCRM Commandes disponibles et exemples d'API REST pour GlueCRM Introduction L'API foncti...

  • Clients

    Client Client - Ajouter un nouveau client POST votredomaine.com/api/customers Header json Champ...

  • Contacts

    Contact Contact - Ajouter un nouveau contact POST votredomaine.com/api/contacts/ Header json Ch...

  • Factures

    Facture Facture - Ajouter une nouvelle facture POST votredomaine.com/api/invoices Header json C...

  • Articles

    Articles Articles - Demander des informations sur les articles OBTENEZ votredomaine.com/api/items/i...