CRM Ondersteuning

updateRecords methode

Doel

U kunt de updateRecords methode gebruiken voor het bijwerken of wijzigen van de records in Zoho CRM.

Belangrijk: Gebruik de POST methode om deze parameters door te geven in plaats van de GET methode.

URL van het verzoek

XML-indeling

Voor het bijwerken van één record in een module in een enkele API-aanroep:

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

Voor het bijwerken van meerdere records in een module in een enkele API-aanroep:

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

Klik op Meerdere records bijwerken voor een voorbeeld van de xmlData en de response voor duplicatencontrole van meerdere records.

Parameters van het verzoek

ParameterGegevenstypeBeschrijving
authtoken*StringVersleutelde alfanumerieke tekenreeks ter verificatie van uw Zoho inloggegevens.
scope*StringVoer als waarde crmapi in
id*StringVoer de unieke ID van de record in
xmlData*XMLVoer velden en corresponderende waarden in
wfTriggerBooleanStel de waarde in als true om de workflow-regels te activeren tijdens het bijwerken van een record in het CRM-account. De standaardwaarde van deze parameter is False.
newFormatInteger (1 of 2)newFormat=1: Om velden met 'null'-waarden uit te sluiten wanneer u gegevens uit uw CRM-account bijwerkt.
newFormat=2: Om velden met 'null'-waarden op te nemen wanneer u gegevens uit uw CRM-account bijwerkt.
versionIntegerversion = 1: (standaardwaarde) Hiermee worden responses opgehaald op basis van de eerdere API-implementatie, d.w.z. van vóór de doorgevoerde verbeteringen.
version = 2: Hiermee worden responses opgehaald op basis van de meest recente API-implementatie.
version = 4: Om meerdere records bij te werken met een enkele API-methode-aanroep.

* - Verplichte parameter

Opmerking:

  • Raadpleeg de Releaseopmerkingen voor meer informatie over doorgevoerde verbeteringen in de API-implementatie.

Aanvullende opmerkingen

  • Tijdens het bijwerken van gegevens in uw Zoho CRM-account wordt beveiliging op basis van rollen (rollen, profielen, beveiliging op veldniveau en regels voor het delen van gegevens) toegepast. Gebruik daarom de gebruikers-ID met de hoogste rol (bijv: CEO) en profiel (bijv: Beheerder). Zorg er ook voor dat alle velden zijn ingeschakeld in de beveiligingsinstellingen op veldniveau. Voor de beveiligingsinstellingen op basis van rollen, zie Beveiligingsbeheer tijdens het genereren van het API-ticket.
  • Zorg er tijdens het bijwerken van gegevens voor dat de datum en het tijdstip op de juiste manier worden genoteerd, respectievelijk mm/dd/jjjj en jjjj-mm-dd uu:mm:ss

Eigenaar van de record bijwerken

Bij het bijwerken van een record via API dient u altijd het e-mailadres of de gebruikers-ID van de record-eigenaar in te voeren. Als u de naam van de record-eigenaar gebruikt, zal de record worden toegewezen aan de standaard aanmeldgegevens die gebruikt zijn in het verificatietoken. Als u gebruik wilt maken van de gebruikers-ID om de record-eigenaar te specificeren, voeg dan de <FL val="SMOWNERID">userID</FL> tag toe aan uw xmlData.

Voorbeelden

Volg de onderstaande stappen om records bij te werken in Zoho CRM:

  1. De URL moet er als volgt uitzien:
    https://crm.zoho.com/crm/private/xml/Leads/updateRecords
  2. De parameters moeten er als volgt uitzien:
    • authtoken: Auth Token
    • scope: Defineer waarde als crmapi.
    • xmlData: Dit is een XML-string en de indeling moet hetzelfde zijn als degene die gebruikt wordt voor het ophalen van records in XML-indeling met uw fetch API.
    • id: id van de bij te werken record

XML-gegevensindeling:
https://crm.zoho.com/crm/private/xml/Leads/updateRecords?newFormat=1&authtoken=Auth Token&scope=crmapi&xmlData=XMLDATA

  • authtoken=xy4gr1554712345fg
  • scope=crmapi
  • xmlData= zoals hieronder vermeld
  • 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>

Taken met contact mapping

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>

Events

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>

Quotes

Opmerking:

  • Het is verplicht een waarde voor 'Product Id’ in te voeren.
  • U kunt de productnaam invoeren indien u niet beschikt over een geldig product-ID.

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

Opmerking:

  • Het is verplicht een waarde voor 'Product Id’ in te voeren.
  • U kunt de productnaam invoeren indien u niet beschikt over een geldig product-ID.

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

<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>
</SalesOrders>

Products

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>

Opmerking:

  • De waarde voor de Handler moet SMOWNERID zijn.

Testprogramma

U kunt het bijgevoegde programma gebruiken om de werking van de updateRecords methode in uw Java-omgeving uit te voeren en te testen.
Het Java-programma bevat het volgende:

  • de indeling van het genereren van het token
  • de parameters en hun waarden
  • het werkelijke gebruik van de methode

Klik hier om het programma te downloaden.

Gebruik van 'CDATA'

Doel: Het aanmerken van speciale tekens als platte tekst en NIET als XML-gegevens

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

Voorbeeld XML-gegevens:

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

Als GET:

<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 %26 A"]]> </FL>
</row>
</Contacts>

Opmerking:

  • '%26' wordt gezien als '&'

Meerdere records bijwerken

Doel

U kunt updateRecords gebruiken voor het bijwerken van meerdere records in een enkele updateRecords API-methode. Vergeet niet dat version=4 een verplichte parameter is.

We hebben een nieuwe code geïntroduceerd die de API-resultaatstatus voor elke record zal representeren. De code staat hieronder vermeld:

2001 = Record bijwerken geslaagd

URL-indeling:

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

Voorbeeld XML-gegevens

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

Voorbeeld response

De functionaliteit en response zien er als volgt uit,

<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">
                        <success>
                            <code>2001</code>
                            <details>
                                <FL val="Id">2000000178702</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>
                </result>
            </response>

Als version=4, en sommige records fouten bevatten en sommige niet, zien de functionaliteit en response er als volgt uit:

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

Opmerking:

  • Als u gebruik maakt van version=4, moet u de ID binnen de xmlData opgeven.
  • Ontwikkelaars kunnen nu gemakkelijk de record-ID herkennen, aangezien de record-informatie in de response op dezelfde manier is gegeven als de user requests in de xml-gegevens.
  • Indien u geen versie ingeeft zal de standaardfunctionaliteit worden uitgevoerd.
  • U kunt maximaal 100 records bijwerken in een enkele API-aanroep.

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocrm.com