Méthode updateRecords

Table des matières

Objectif
URL de la demande
Paramètres de la demande
Notes supplémentaires
Mise à jour du propriétaire de l'enregistrement
Exemples
Programme de test
Utilisation de « CDATA »
Mises à jour de plusieurs enregistrements

Objectif

Vous pouvez utiliser la méthode updateRecords pour mettre à jour ou modifier les enregistrements dans Zoho CRM.

Note importante : utilisez la méthode POST pour transmettre ces paramètres au lieu de la méthode GET.

URL de demande

Format XML

Pour la mise à jour d'un enregistrement unique dans un module en un seul appel d'API :

https://crm.zoho.com/crm/private/xml/Leads/updateRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&xmlData=XML Data

Pour la mise à jour de plusieurs enregistrements dans un module en un seul appel d'API :

https://crm.zoho.com/crm/private/xml/Leads/updateRecords?authtoken=Auth Token&scope=crmapi&version=4&xmlData=XML Data

Cliquez sur Multiple Record Updates (Plusieurs mises à jour) pour visualiser les exemples de données XML et de réponse pour la vérification des doublons de plusieurs enregistrements.

Paramètres de demande

Paramètre	Type de données	Description
authtoken*	Chaîne	Chaîne alphanumérique chiffrée utilisée pour l'authentification de vos identifiants Zoho.
scope*	Chaîne	Entrez la valeur crmapi
id*	Chaîne	Indiquez l'ID unique de l'enregistrement
xmlData*	XML	Précisez les champs et les valeurs correspondantes
wfTrigger	Champs booléens	Définir la valeur sur true pour déclencher la règle de workflow lors de la mise à jour de l'enregistrement dans le compte CRM. Par défaut, la valeur de ce paramètre est false.
newFormat	Entier (1 ou 2)	newFormat=1 : pour exclure les champs avec des valeurs « null » lors de la mise à jour des données de votre compte CRM. newFormat=2 : pour inclure des champs avec des valeurs « null » lors de la mise à jour des données de votre compte CRM.
version	Entier	version = 1 : (valeur par défaut) permet de récupérer les réponses en fonction de la version d'API mise en œuvre précédemment, c.-à-d. avant les améliorations apportées. version = 2 : permet de récupérer les réponses en fonction de l'API la plus récente. version = 4 : pour la mise à jour de plusieurs enregistrements avec un seul appel de méthode API.

* - Paramètre obligatoire

Remarque :

consultez la page des Notes de mise à jour pour en savoir plus sur les améliorations apportées à la mise en œuvre de l'API.

Notes supplémentaires

Lors de la mise à jour des données dans votre compte Zoho CRM, la sécurité fondée sur les rôles (rôles, profils, sécurité au niveau des champs de données et règles de partage des données) est appliquée. Par conséquent, utilisez l'ID d'utilisateur avec le rôle de plus haut niveau (ex. : PDG) et le profil de plus haut niveau (ex. : administrateur). Assurez-vous également que tous les champs sont activés dans les paramètres de sécurité au niveau des champs. Pour les paramètres de sécurité fondée sur les rôles, consultez Administration de la sécurité lors de la génération d'un ticket d'API.
Lors de la mise à jour des données, assurez-vous que la date et l'heure sont dans les formats mm/jj/aaaa et aaaa-mm-jj hh:mm:ss respectivement.

Mise à jour du propriétaire de l'enregistrement

Durant la mise à jour d'un enregistrement via l'API, assurez-vous que vous indiquez l'adresse e-mail ou l'ID d'utilisateur du propriétaire de l'enregistrement. Si vous utilisez le nom du propriétaire de l'enregistrement, l'enregistrement sera attribué aux identifiants de connexion par défaut utilisés dans le jeton d'authentification. Si vous souhaitez utiliser l'ID d'utilisateur pour définir le propriétaire de l'enregistrement, ajoutez l'étiquette <FL val="SMOWNERID">userID</FL> à vos données XML.

Exemples

Pour mettre à jour les enregistrements dans Zoho CRM, procédez comme suit :

L'URL doit être conforme à celle indiquée ci-dessous :
https://crm.zoho.com/crm/private/xml/Leads/updateRecords
Les paramètres doivent être conformes à ceux indiqués ci-dessous :
- authtoken : Auth Token
- scope : Définissez la valeur comme crmapi.
- xmlData : ceci est une chaîne XML et le format doit être identique à celui utilisé pour obtenir des enregistrements au format XML avec l'API Fetch.
- id : ID de l'enregistrement à mettre à jour

Format de données XML :
https://crm.zoho.com/crm/private/xml/Leads/updateRecords?newFormat=1&authtoken=Auth Token&scope=crmapi&xmlData=XMLDATA

authtoken=xy4gr1554712345fg
scope=crmapi
xmlData= comme indiqué ci-dessous
id = 1000000019001

<Leads>
<row no="1">
<FL val="Lead Source">Web Download</FL>
<FL val="First Name">contacto 1</FL>
<FL val="Last Name">apellido</FL>
<FL val="Email">testing@testing.com</FL>
<FL val="Title">Manager</FL>
<FL val="Phone">1234567890</FL>
<FL val="Home Phone">0987654321</FL>
<FL val="Other Phone">1212211212</FL>
<FL val="Fax">02927272626</FL>
<FL val="Mobile">292827622</FL>
</row>
</Leads>

Tâches avec mappage de contacts

https://crm.zoho.com/crm/private/xml/Tasks/updateRecords?authtoken=AuthToken&scope=crmapi
&newFormat=1
&id=2000000017022
&xmlData=

<Tasks>
<row no="1">
<FL val="Subject">Meeting Hall</FL>
<FL val="Due Date">2009-04-22</FL>
<FL val="Status">Completed</FL>
<FL val="CONTACTID">2000000017027</FL>
</row>
</Tasks>

Événements

https://crm.zoho.com/crm/private/xml/Events/updateRecords?authtoken=AuthToken&scope=crmapi
&newFormat=1
&id=2000000017023
&xmlData=

<Events>
<row no="1">
<FL val="Subject">Conference</FL>
<FL val="Start DateTime">2009-08-04 01:00:00</FL>
<FL val="End DateTime">2009-08-05 01:00:00</FL>
<FL val="Venue">Plaza</FL>
<FL val="Send Notification Email">false</FL>
</row>
</Events>

Contacts

https://crm.zoho.com/crm/private/xml/Contacts/updateRecords?authtoken=AuthToken&scope=crmapi
&newFormat=1
&id=2000000017024
&xmlData=

<Contacts>
<row no="1">
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Email">test@test.com</FL>
<FL val="Department">CG</FL>
<FL val="Phone">989898988</FL>
<FL val="Fax">99999999</FL>
<FL val="Mobile">99989989</FL>
<FL val="Assistant">John</FL>
</row>
</Contacts>

Devis

Remarque :

Une valeur pour l'ID du produit est obligatoire.
Vous pouvez indiquer le nom du produit si vous ne disposez pas d'un ID de produit valide.

https://crm.zoho.com/crm/private/xml/Quotes/updateRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&id=2000000017025
&xmlData=<Quotes>

<row no="1">
<FL val="Subject">Zillium - SO</FL>
<FL val="Due Date">2009-03-10</FL>
<FL val="Sub Total">48000.0</FL>
<FL val="Tax">0.0</FL>
<FL val="Adjustment">0.0</FL>
<FL val="Grand Total">48000.0</FL>
<FL val="Billing Street">test</FL>
<FL val="Shipping Street">test</FL>
<FL val="Billing City">test</FL>
<FL val="Shipping City">test</FL>
<FL val="Billing State">test</FL>
<FL val="Shipping State">test</FL>
<FL val="Billing Code">223</FL>
<FL val="Shipping Code">223</FL>
<FL val="Billing Country">test</FL>
<FL val="Shipping Country">test</FL>
<FL val="Product Details">
<product no="1">
<FL val="Product Id">2000000017001</FL>
<FL val="Unit Price">10.0</FL>
<FL val="Quantity">1.0</FL>
<FL val="Total">123.0</FL>
<FL val="Discount">1.23</FL>
<FL val="Total After Discount">121.77</FL>
<FL val="List Price">123.0</FL>
<FL val="Net Total">121.77</FL>
</product>
</FL>
<FL val="Terms and Conditions">Test by Zoho</FL>
<FL val="Description">Test By Zoho</FL>
</row>
</Quotes>

SalesOrders

Remarque :

Vous pouvez indiquer le nom du produit si vous ne disposez pas d'un ID de produit valide.

https://crm.zoho.com/crm/private/xml/SalesOrders/updateRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&id=2000000017026
&xmlData=<SalesOrders>

Produits

https://crm.zoho.com/crm/private/xml/Products/updateRecords?authtoken=491e5e3374b0132324lqs2f1scb18cd0&
newFormat=1&scope=crmapi&id=508020000000366001&xmlData=

<Products>
<row no="1">
<FL val="Product Owner">manishp@zillum.com</FL>
<FL val="Product Name">Product Test</FL>
<FL val="Product Code">098732</FL>
<FL val="VENDORID">508020000000038476</FL>
<FL val="Product Active">true</FL>
<FL val="Manufacturer">AltvetPet Inc.</FL>
<FL val="Product Category">CRM App</FL>
<FL val="Sales Start Date">11/09/2012</FL>
<FL val="Sales End Date">11/11/2012</FL>
<FL val="Support Start Date">11/16/2012</FL>
<FL val="Support Expiry Date">11/18/2012</FL>
<FL val="Amount">100</FL>
<FL val="Probability">2</FL>
<FL val="Expected Revenue">200</FL>
<FL val="Unit Price">200</FL>
<FL val="Commission Rate">2</FL>
<FL val="Tax">Sales Tax;asdf</FL>
<FL val="Taxable">true</FL>
<FL val="Usage Unit">Dozen</FL>
<FL val="Qty Ordered">500000</FL>
<FL val="Qty in Stock">200000</FL>
<FL val="Reorder Level">10000</FL>
<FL val="Qty in Demand">10</FL>
<FL val="Handler">508020000000210005</FL>
<FL val="Description">Description Added for the product</FL>
</row>
</Products>

Remarque :

La valeur pour le responsable doit être SMOWNERID.

Programme de test

Vous pouvez utiliser le programme ci-joint pour exécuter et tester le fonctionnement de la méthode updateRecords dans votre environnement Java.
Le programme Java contient les éléments suivants :

format de génération du jeton
paramètres et leurs valeurs
utilisation réelle de la méthode

Cliquez ici pour télécharger le programme.

Utilisation de « CDATA »

Objectif : considérer les caractères spéciaux comme du texte brut et NON PAS comme des données XML

Format de l'URL :
https://crm.zoho.com/crm/private/xml/Contacts/updateRecords?newFormat=1&authtoken=Auth Token&scope=crmapi&id=50000000216189251

Exemples de données XML :

en tant que POST :

<Contacts>
<row no="1">
<FL val="First Name">Amy</FL>
<FL val="Last Name">Dawson</FL>
<FL val="Email">testing@testing.com</FL>
<FL val="Title">Manager</FL>
<FL val="Phone">1234567890</FL>
<FL val="Mobile">292827622</FL>
<FL val="Account Name"><![CDATA["A & A"]]></FL>
</row>
</Contacts>

en tant que GET :

Remarque :

"%26" sera considéré comme « & »

Mises à jour de plusieurs enregistrements

Objectif

Vous pouvez utiliser updateRecords pour mettre à jour de plusieurs enregistrements avec un seul appel de la méthode d'API updateRecords. Veuillez noter que version=4 est un paramètre obligatoire.

Nous avons introduit un nouveau code qui représente le statut des résultats de l'API pour chaque enregistrement. Ce code est le suivant :

2001 = Mise à jour de l'enregistrement réussie

Format de l'URL :

https://crm.zoho.com/crm/private/xml/Leads/updateRecords?authtoken=Auth Token&scope=crmapi&version=4&xmlData=

Exemple de données XML

<Leads>
  <row no="1">
<FL val="Id">2000000178701</FL>
<FL val="Company">Company1</FL>
<FL val="Last Name">Last Name1</FL>
<FL val="Email">automation@crm.com 1</FL>
  </row>
  <row no="2">
<FL val="Id">2000000178702</FL>
<FL val="Company">Company2</FL>
<FL val="Last Name">Last Name2</FL>
<FL val="Email">automation@crm.com 2</FL>
  </row>
</Leads>

Exemple de réponse

La fonctionnalité et la réponse seront indiquées comme ci-dessous :

Si version=4, certains enregistrements contiennent des erreurs et d'autres pas, la fonctionnalité et la réponse seront indiquées comme suit :

<response uri="/crm/private/xml/Leads/insertRecords">
        <result>
          <row no="1">
            <success>
              <code>2001</code>
              <details>
                <FL val="Id">2000000178701</FL>
                <FL val="Created Time">2013-02-11 17:55:04</FL>
                <FL val="Modified Time">2013-02-11 17:55:04</FL>
                <FL val="Created By">
                <![CDATA[ aghil123 ]]>
                </FL>
                <FL val="Modified By">
                <![CDATA[ aghil123 ]]>
                </FL>
              </details>
            </success>
          </row>
          <row no="2">
            <error>
              <code>4832</code>
                           <details>You have given a wrong value for the field : Annual Revenue</details>
            </error>
          </row>
        </result>
      </response>

Remarque :

Si vous utilisez version=4, vous devez fournir l'ID dans les données xml.
Les développeurs sont désormais en mesure d'identifier facilement l'ID de l'enregistrement, car les informations de l'enregistrement comprises dans la réponse sont fournies de la même façon que les demandes de l'utilisateur dans les données XML.
Si vous ne transmettez pas la version, la fonctionnalité par défaut sera exécutée.
Vous pouvez mettre à jour 100 enregistrements au maximum en un seul appel d'API.

Was this article helpful? Yes, thanks!Not really

Share this post : FacebookTwitter

Top

Vous ne trouvez toujours pas ce que vous cherchez?

Écrivez-nous: support@zohocrm.com

Aide CRM

Méthode updateRecords

Table des matières

Objectif

URL de demande

Paramètres de demande

Notes supplémentaires

Mise à jour du propriétaire de l'enregistrement

Exemples

Tâches avec mappage de contacts

Événements

Contacts

Devis

SalesOrders

Produits

Programme de test

Utilisation de « CDATA »

Mises à jour de plusieurs enregistrements

Objectif

Format de l'URL :

Exemple de données XML

Exemple de réponse

Was this article helpful? Yes, thanks!Not really

Vous ne trouvez toujours pas ce que vous cherchez?