Recherche dans la base de connaissances

Contacts

Contact

Contact - Ajouter un nouveau contact

POST votredomaine.com/api/contacts/

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base

Paramètre

json

Champ

Type

Description

customer_id

Number

Identifiant client obligatoire.

firstname

String

Prénom obligatoire

lastname

String

Nom de famille obligatoire

email

String

Courriel obligatoire

title (facultatif)

String

Poste optionnel

phonenumber (facultatif)

String

Numéro de téléphone facultatif

direction (facultatif)

String

Direction facultative (rtl ou ltr)

Valeur par défaut:rtl

password (facultatif)

String

Mot de passe facultatif (requis uniquement si vous passez le paramètre send_set_password_email)

is_primary (facultatif)

String

Contact principal facultatif (activé ou non)

Valeur par défaut:on

donotsendwelcomeemail (facultatif)

String

Facultatif Ne pas envoyer d'e-mail de bienvenue (activer ou ne pas le transmettre)

send_set_password_email (facultatif)

String

Envoi facultatif de l'e-mail de définition du mot de passe (activé ou non)

permissions (facultatif)

Déployer

Authorizations facultatives pour ce contact(["1", "2", "3", "4", "5", "6" ]) [ "1", // Authorization Factures "2",
//
Authorization
Estimations
" 3", // Authorization des contrats
"4", // Authorization des propositions
"5", // Authorization du support
"6" // Authorization des projets
]

invoice_emails (facultatif)

String

Notification par e-mail facultative pour les factures (définissez la même valeur que le nom ou ne la transmettez pas)

Valeur par défaut:invoice_emails

estimate_emails (facultatif)

String

Notification par e-mail facultative pour l'estimation (définir la même valeur que le nom ou ne pas la transmettre)

Valeur par défaut:estimate_emails

credit_note_emails (facultatif)

String

Notification par e-mail facultative pour la note de crédit (définissez la même valeur que le nom ou ne la transmettez pas)

Valeur par défaut:credit_note_emails

project_emails (facultatif)

String

Notification par e-mail facultative pour le projet (définissez la même valeur que le nom ou ne la transmettez pas)

Valeur par défaut:project_emails

ticket_emails (facultatif)

String

Notification par e-mail facultative pour les billets (définissez la même valeur que le nom ou ne la transmettez pas)

Valeur par défaut:ticket_emails

task_emails (facultatif)

String

Notification par e-mail facultative pour la tâche (définissez la même valeur que le nom ou ne la transmettez pas)

Valeur par défaut:task_emails

contract_emails (facultatif)

String

Notification par e-mail facultative pour le contrat (définir la même valeur que le nom ou ne pas la transmettre)

Valeur par défaut:contract_emails

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande.

message

String

Contact ajouté avec succès.

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande

message

String

Échec de l'ajout du contact

e-mail

String

Cet e-mail existe déjà

  • Réponse réussie

HTTP/1.1 200 OK{ "status": true, "message": "Contact added successfully"}

  • Réponse d’erreur

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

Contact - Supprimer le contact

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

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base

Paramètre

json

Champ

Type

Description

Customer_id

Number

identifiant client unique

Succès 200

json

Champ

Type

Description

status

String

État de la demande.

message

String

Contact supprimé avec succès

Erreur 4xx

json

Nom

Type

Description

status

booléen

État de la demande

message

String

Échec de la suppression du contact

  • Réponse réussie

HTTP/1.1 200 OK{ "status": true, "message": "Contact Deleted Successfully"}

  • Réponse d’erreur

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

Contact - Liste tous les contacts d'un client

OBTENEZ votredomaine.com/api/contacts/:customer_id/:contact_id

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base

Paramètre

json

Champ

Type

Description

Customer_id

Number

Identifiant unique du client obligatoire

contact_id

Number

Identifiant unique du contact facultatif
Remarque : si vous ne transmettez pas l'identifiant du contact, tous les contacts du client seront répertoriés

Succès 200

json

Champ

Type

Description

Contact

Objet

Coordonnées

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": "6",
"userid": "1",
"company": "xyz",
"vat": "",
"phonenumber": "1234567890",
"country": "0",
"city": "",
"zip": "360005",
"state": "",
"address": "",
"website": "",
"datecreated": "2020-08-19 20:07:49",
"active": "1",
"leadid": null,
"billing_street": "",
"billing_city": "",
"billing_state": "",
"billing_zip": "",
"billing_country": "0",
"shipping_street": "",
"shipping_city": "",
"shipping_state": "",
"shipping_zip": "",
"shipping_country": "0",
"longitude": null,
"latitude": null,
"default_language": "english",
"default_currency": "0",
"show_primary_contact": "0",
"stripe_id": null,
"registration_confirmed": "1",
"addedfrom": "1"
}
Error-Response:

  • Réponse d’erreur

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

Contact - Recherche d'informations de contact

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

Header

json

Champ

Type

Description

Authorization

String

Jeton d'authentification d'accès de base

Paramètre

json

Champ

Type

Description

keysearch

String

Rechercher des mots-clés

Succès 200

json

Champ

Type

Description

Contact

Objet

Coordonnées

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": "8",
"userid": "1",
"is_primary": "0",
"firstname": "chirag",
"lastname": "jagani",
"email": "useremail@gmail.com",
"phonenumber": "",
"title": null,
"datecreated": "2020-05-19 20:07:49",
"password": "$2a$08$6DLJFalqvJGVymCwW2ppNe9HOG5YUP04vzthXZjOFFUQknxfG6QHe",
"new_pass_key": null,
"new_pass_key_requested": null,
"email_verified_at": "2020-08-28 21:36:06",
"email_verification_key": null,
"email_verification_sent_at": null,
"last_ip": null,
"last_login": null,
"last_password_change": null,
"active": "1",
"profile_image": null,
"direction": null,
"invoice_emails": "0",
"estimate_emails": "0",
"credit_note_emails": "0",
"contract_emails": "0",
"task_emails": "0",
"project_emails": "0",
"ticket_emails": "0",
"company": "trueline",
"vat": "",
"country": "0",
"city": "",
"zip": "",
"state": "",
"address": "",
"website": "",
"leadid": null,
"billing_street": "",
"billing_city": "",
"billing_state": "",
"billing_zip": "",
"billing_country": "0",
"shipping_street": "",
"shipping_city": "",
"shipping_state": "",
"shipping_zip": "",
"shipping_country": "0",
"longitude": null,
"latitude": null,
"default_language": "english",
"default_currency": "0",
"show_primary_contact": "0",
"stripe_id": null,
"registration_confirmed": "1",
"addedfrom": "1"
}

  • Réponse d’erreur

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

Contact - Mettre à jour les informations de contact

METTRE votredomaine.com/api/contacts/: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 de contact client obligatoire.

firstname

String

Prénom obligatoire

lastname

String

Nom de famille obligatoire

email

String

Courriel obligatoire

title (facultatif)

String

Poste optionnel

phonenumber (facultatif)

String

Numéro de téléphone facultatif

direction (facultatif)

String

Direction facultative (rtl ou ltr)

Valeur par défaut:rtl

password (facultatif)

String

Mot de passe facultatif (requis uniquement si vous passez le paramètre send_set_password_email)

is_primary (facultatif)

String

Contact principal facultatif (activé ou non)

Valeur par défaut:on

donotsendwelcomeemail (facultatif)

String

Facultatif Ne pas envoyer d'e-mail de bienvenue (activer ou ne pas le transmettre)

send_set_password_email (facultatif)

String

Envoi facultatif de l'e-mail de définition du mot de passe (activé ou non)

permissions (facultatif)

Déployer

Authorizations facultatives pour ce contact(["1", "2", "3", "4", "5", "6" ]) [ "1", // Authorization Factures "2",
//
Authorization
Estimations
" 3", // Authorization des contrats
"4", // Authorization des propositions
"5", // Authorization du support
"6" // Authorization des projets
]

invoice_emails (facultatif)

String

Notification par e-mail facultative pour les factures (définissez la même valeur que le nom ou ne la transmettez pas)

Valeur par défaut:invoice_emails

estimate_emails (facultatif)

String

Notification par e-mail facultative pour l'estimation (définir la même valeur que le nom ou ne pas la transmettre)

Valeur par défaut:estimate_emails

credit_note_emails (facultatif)

String

Notification par e-mail facultative pour la note de crédit (définissez la même valeur que le nom ou ne la transmettez pas)

Valeur par défaut:credit_note_emails

project_emails (facultatif)

String

Notification par e-mail facultative pour le projet (définissez la même valeur que le nom ou ne la transmettez pas)

Valeur par défaut:project_emails

ticket_emails (facultatif)

String

Notification par e-mail facultative pour les billets (définissez la même valeur que le nom ou ne la transmettez pas)

Valeur par défaut:ticket_emails

task_emails (facultatif)

String

Notification par e-mail facultative pour la tâche (définissez la même valeur que le nom ou ne la transmettez pas)

Valeur par défaut:task_emails

contract_emails (facultatif)

String

Notification par e-mail facultative pour le contrat (définir la même valeur que le nom ou ne pas la transmettre)

Valeur par défaut:contract_emails

Succès 200

json

Champ

Type

Description

status

booléen

État de la demande

message

String

Contact mis à jour avec succès

Erreur 4xx

json

Nom

Type

Description

e-mail

String

Cet e-mail existe déjà

status

booléen

État de la demande

message

String

Échec de l'ajout du contact

  • Réponse réussie

HTTP/1.1 200 OK{ "status": true, "message": "Contact Updated Successfully"}

  • Réponse d’erreur

HTTP/1.1 409 Conflict {

"status": false, "error": {

"email":"This Email is already exists"

},

"message": "This Email is already exists" }

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...

  • 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...

  • Prospects

    Prospects Prospect - Ajouter un nouveau prospect POST votredomaine.com/api/leads Header json Ch...