Import Using External Reference IDs

If needed, you can import object and relationship data using an object type’s External Reference Object Type ID or a relationship’s External Reference Relationship Type ID (instead of the Object Type ID or Relationship ID). This feature is useful when importing objects into multiple organizations that were recently imported through Org Manager as the object type and relationships retain their external reference IDs and already exist in the imported org, allowing you to use the same import spreadsheet for more than one duplicate organization.

When importing data, you may use only the object type and relationship IDs OR external reference IDs in each spreadsheet.

To import data using object type/relationship type External Reference IDs:

  1. Obtain the object type ID for the object type or the object type where the relationship is saved. See steps 1-3 in the Enter New Object Data section for information on obtaining the object type ID.
  2. Click the icon in the top bar > Swagger Docs in the Tools section.
  3. Click ObjectType to display the Object Service API page.
  4. To obtain the External Reference Object Type ID for an object type:
    1. From the Object Service API page, click GET next to /objectType/{id}.
      The objectType section of the Object Service API page.
    2. In the id field, under Parameters, enter the object type ID.
      The id field in the Parameters section.
    3. Click Try it out! in the Response Messages section.
      The Try it out! button in the Response Messages section.
    4. Scroll down to the Response Body section to retrieve the object type’s External Reference Object Type ID, which is the value displayed beside externalRefID.
      The object type's external reference ID in the Response Body section.
  5. To obtain the External Reference Relationship Type ID for a relationship:
    1. From the Object Service API page, click relationshipTypes. 
    2. Click GET next to /objectType/{objectTypeID}/relationship.
      The relationshipTypes section of the Object Service API page.
    3. In the objectTypeId field, under Parameters, enter the object type ID for the object type where the relationship is saved.
      The objectTypeId field in the Parameters section.
    4. Click Try it out! in the Response Messages section.
      The Try it out! button in the Response Messages section.
    5. Scroll down to the Response Body section, which displays all relationships saved to the object type selected. You can identify each relationship by the entries next to “name” and “longName” (if a long name was specified) in Response Body. The value displayed beside externalRefID is the External Reference Relationship Type ID.
      The Response Body section which displays all the relationships saved to the selected object type.
  6. If importing objects, on an object type worksheet in the data import spreadsheet, enter the External Reference Object Type ID below Object Type ID on row 2, column A. If importing relationships, enter the External Reference Relationship Type ID below Relationship ID on row 2, column A on a relationship worksheet.
    Entering the External Reference Object Type ID below the Object Type ID cell in the data import spreadsheet.
    Using the : symbol in an External Reference ID to create new objects is not recommended.
  7. Continue entering object or relationship data as needed.
  8. Upload the spreadsheet.