Overview

Skill Level: Intermediate

Step-by-step

  1. Syntax of the request and response XML for CreateContactList

    Operation <CreateContactList>  
    Elements DATABASE_ID The ID of the database the Contact List is associated with.
    CONTACT_LIST_NAME The name for the Contact List to be created.  
    VISIBILITY Defines the visibility of the Contact List being created.

    0 – Private

    1 – Shared

     
    CREATE_PARENT_FOLDER Optional Used to specify that¬†if PARENT_FOLDER_PATH¬†specified doesn’t exist then system should create that folder.¬†If the user has folder limit assigned at the Org level, then contact list is created from user‚Äôs root folder/<path specified>
    PARENT_FOLDER_ID Optional Used to specify the ID of the Contact List folder you want to place the Contact List in. The specified folder must exist in the Contact List structure and the user must have access to the folder.
    PARENT_FOLDER_PATH Optional Used to specify the path of the Contact List folder you want to place the Contact List in. The specified folder must exist in the Contact List structure and the user must have access to the folder.
    Example
    <Envelope>
      <Body>
        <CreateContactList>
          <DATABASE_ID>565576</DATABASE_ID>
          <CONTACT_LIST_NAME>Re-marketing Contacts</CONTACT_LIST_NAME>
          <VISIBILITY>0</VISIBILITY>
          <PARENT_FOLDER_PATH>Main Folder/SubFolder</PARENT_FOLDER_PATH>
          <CREATE_PARENT_FOLDER/>
        </CreateContactList>
      </Body>
    </Envelope>
     
    Response <RESULT>  
    Elements SUCCESS True if successful
    CONTACT_LIST_ID The ID of the Contact List that was created.  
    Example
    <Envelope>
      <Body>
        <RESULT>
          <SUCCESS>TRUE</SUCCESS>
          <CONTACT_LIST_ID>33535067</CONTACT_LIST_ID>
        </RESULT>
      </Body>
    </Envelope>
    
     

2 comments on"Create a contact list"

  1. How do I discover the PARENT_FOLDER_ID in the GUI? When I go to Data > Contact Lists, I cannot hover over the folder to get the ID by pop-up nor URL, nor are there any details links for the folder. So if the folder was created in the GUI, how would one know what value to use for the PARENT_FOLDER_ID in this API call? Thanks.

    • Hi Tom,
      If you hover over the name of the database that the Contact list was created from, you’ll see an ID. Let me know if that works for you.

      Thank you
      jeri

Join The Discussion

Your email address will not be published. Required fields are marked *