ZeeMee API Integration

Updated Sep 30, 2026Article

Overview#

ZeeMee supports sending data via API, as opposed to flat file SFTP. An API integration can quickly be achieved using the Import and Export Templates and Segment created for the SFTP integration.

Notify your ZeeMee Partner Success Director if you wish to use an API integration.

Items for ZeeMee#

Send these items to ZeeMee. Descriptions of each item are below.

API Key
Feature Token
Import Template GUID
Export Template GUID
Export Segment GUID(s)

Creating API Credentials for ZeeMee#

The ZeeMee team will require a key to access the API. Follow the steps in this article to generate a unique API key for ZeeMee to use. Be sure to include the Feature token in your communication to them.

PLEASE SEND API CREDENTIALS THROUGH SECURE EMAIL.

Template GUIDs and Segment GUID#

ZeeMee will need the Import and Export template GUIDs you would like to use, and the Segment GUID of the Segment you wish to send to ZeeMee. The GUIDs are the unique identifiers for each item in Element451. Find them at the end of the URL when the item is opened in Element415 (example).

Using the ZeeMee Community Data Import & ZeeMee Community Data Export Templates

The ZeeMee Import and Export templates were built for Flat File integrations with ZeeMee, but can also be used for this API integration. However, you will need to create a local copy of each template. Follow these instructions to create a local copy of the ZeeMee Community Data Export template

Step 1: Locate the ZeeMee Community Data Export under “System Export Mapping Templates”

Element451 System Export Mapping Templates list, with ZeeMee Community Data Export at the top — Element451 Imports/Exports templates area, System Export Mapping Templates list. Rows shown: ZeeMee Community Data Export, Encoura Standard Layout (2024-2025) and EAB Enroll360 Test Scores, each with a download icon.

This is the “system” template that all Element451 partners can use.

Step 2: Open the template and select “Save as template” from the top right.

ZeeMee Community Data Export template in Element451 with the Save as template button at top right — Element451 export mapping template titled ZeeMee Community Data Export. The Mapping data section has Load template and Save as template buttons at the top right. Rows map fields to headers: First Name (user-first-name) to FirstName, Last Name to LastName, Email (user-email-address) to Email, and a partly visible Phone Cell - Number row.

This will create a local copy. Give it a name, like “[COPY] ZeeMee Community Data Export” or something that better aligns with your naming convention.

Step 3: In the copy, locate fields with a scope error

Element451 export template rows; Application Student Type shows a red exclamation scope error icon — Element451 export mapping template rows 6 to 12. Row 9, Application Student Type (user-applications-student-type) mapped to header StudentType, has a red circled exclamation mark that flags a scope error, next to a blue scope icon. Rows 7, 8 and 11 (EntryYear, EntryTerm, EmailOptOut) are shaded calculated columns; the others are Preferred First Name, Middle Name and Home Address - Street 1.

The “Scope” error is denoted by the red exclamation point icon. This means the field needs additional configuration. For the Community Data Export, each field with a slug like “user-applications-...” will have a scoping error.

Step 4: For each field with a scope error, set the scope in the column settings.

Element451 column settings Scope tab with the Application dropdown open: Blank, Undergraduate, Graduate — Element451 export template column settings with tabs Scope, General, Transformations, Validations and Empty values; Scope is active. The Application dropdown is open, listing Blank, Undergraduate Appication (misspelled in the UI) and Graduate Application.

In this example, the scope prompts us to select an application type. In general, you should select the same application type for each field with a slug like “user-applications-...”

Step 5: Provide the GUID of your new template to the ZeeMee team.

Element451 export template URL ending template=instance.template.19830, the GUID to give ZeeMee — Browser address bar showing https://instance.element451.io/v2/import-export/templates/export?template=instance.template.19830, above an open Column Settings - StudentType panel for the ZeeMee Community Data export template. The template GUID is the last part of the URL, instance.template.19830.

The GUID is found at the last part of the URL. In this example, the GUID is “instance.template.19830”.