Genesys Cloud - Developer Community!

 View Only

Sign Up

  • 1.  Bulk Import External Contacts APIs

    Posted 2 days ago

    Good morning all.

    Hope you are all doing well heading towards the Christmas period.

    Firstly, I'm not GC developer by trade and I have a couple of questions I hope someone could provide me with some guidance.

    It's regarding the step-by-step guide to "Bulk Import External Contacts APIs", specifically 'Step 2-1-2 Update an Import Setting'.

    Question 1

    Why are we updating the csv Import Setting again, when we've only just created it in the preceding 'Step 2-1-1 Create an Import Setting'?

    Question 2
    Step 2-1-2 is referring to 'POST /api/v2/externalcontacts/import/csv/settings'.

    If I look at the API on Platform APIs, and loading an empty schema, it does not include fields for "name" and "matching criteria".

    Is this then the wrong API for Step 2-1-2?

    If there is a need to update the previously created setting, I feel there should be some form of description as to why it's being done, would you not agree?

    Question 3.

    For the time being, assuming that it is the right API.

    The Request Template for 'POST /api/v2/externalcontacts/import/csv/settings' is exactly the same as the Response Results below.

    Is this correct?

    Thank you all in advance for your time and patience.

    Bulk Import External Contacts APIs

    Bulk Import External Contacts APIs


    #PlatformAPI

    ------------------------------
    Bernard
    CALLSCAN AUSTRALIA PTY. LTD.
    ------------------------------


  • 2.  RE: Bulk Import External Contacts APIs

    Posted 2 days ago

    Hello,

    I have asked the engineering team managing these endpoints and here are their answers.

    Question 1:

    "it's a bit misleading, so you either create an import setting or update an existing one. You don't have to do both --> either you do 2.1.1 or 2.1.2"
    "In case you create a new Import Setting (POST /api/v2/externalcontacts/import/settings), you need to set up the CSV Settings as well (POST /api/v2/externalcontacts/import/csv/settings) and reference the Import Setting's ID ("id": "01958aca-6604-70fc-b70e-ce1eecc2a1cb" in first response) in the externalSettingsId field ("externalSettingsId": "01958aca-6604-70fc-b70e-ce1eecc2a1cb" in second request). This is outlined in 2.1.1."

    Question 2:

    "The documentation has a small issue, step 2-1-2 mentions POST /api/v2/externalcontacts/import/csv/settings while it should be POST /api/v2/externalcontacts/import/settings"

    They have just noticed this typo and will create a fix for the documentation.

    Question 3:

    "question3 is an assumption based on the incorrect documentation

    It's important to highlight that there's a POST /api/v2/externalcontacts/import/csv/settings to set up the CSV settings (field mappings and link to an Import Setting) and a POST /api/v2/externalcontacts/import/settings endpoint, which creates the Import setting with configuration options for which external source the import should be run against, matching criterias (which fields identity resolution will be based on), etc. This can be confusing at first too"

    Hope this clarifies.

    Regards,



    ------------------------------
    Jerome Saint-Marc
    Senior Development Support Engineer
    ------------------------------

    Original Message


  • 3.  RE: Bulk Import External Contacts APIs

    Posted yesterday

    Hello,

    I don't seem to be able to reply to the message you have sent me by email/directly.

    So answering here.

    Question 1:

    I assume the logic of 2.1 was that if you want to create a new import settings (2.1.1), if you want to modify/update an existing import settings (2.1.2). If you want to list the import settings that you have already created (2.1.3).

    Question 2:

    Yes. Typos even occur in books.

    Question 1, 2 & 3:

    At the bottom of each dev center page, there is a section to collect feedback or report bugs -> "Was this page helpful?"

    Regards,



    ------------------------------
    Jerome Saint-Marc
    Senior Development Support Engineer
    ------------------------------

    Original Message


  • 4.  RE: Bulk Import External Contacts APIs

    Posted yesterday

    Thank you for your time and response Jerome.

    I will certainly make use of the Feedback button to fix the gaps and wording in parts following a response to my Case which I have open in parallel with Genesys Support.



    ------------------------------
    Bernard
    CALLSCAN AUSTRALIA PTY. LTD.
    ------------------------------

    Original Message


Related Content