Knowledge Base on DreamApply Knowledge Base

Academic term

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single academic term.

URI

/api/v9/academic-terms/ID

Get an academic term

List academic terms configured into the system. These are the main “buckets” where applications are categorized. An example of an academic term is Fall 2016 or Spring 2017.

Syntax

GET /api/v9/academic-terms/123
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/academic-terms/123"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The academic term data was successfully returned
`404 Not Found`	The academic term was not found

Example response

Response

 
 
 
{
 "id": 123,
 "year": "/api/v9/academic-years/2025",
 "name": "Spring semester 2025/26",
 "type": "/api/v9/academic-terms/types/2",
 "start": "2026-01-01",
 "grace": "2026-01-08",
 "finish": "2026-05-31"
}

Catalog setup basics

Mon, 01 Jan 0001 00:00:00 +0000

The programme catalog in DreamApply helps institutions organize and manage their academic offerings in a structured way.

Programme catalog structure

DreamApply allows institutions to organize programmes in various ways to support different academic structures. Programmes can be:

Grouped by department: Programmes can belong to different academic departments within an institution.
Linked to an institution: Programmes can be directly linked to an institution.

In addition to structuring by institution and department, programmes are always linked to specific intakes, which defines when they are open for admission.

Citizenships

Mon, 01 Jan 0001 00:00:00 +0000

The following list of citizenships is used throughout the platform whenever nationality information is required. DreamApply relies on the ISO 3166-1 alpha-2 codes standard. In addition, it includes a limited number of temporary country codes for regions and territories not officially assigned ISO codes, such as Kosovo and Northern Cyprus.

Code	Country Name
AF	Afghanistan
AX	Åland Islands
AL	Albania
DZ	Algeria
AS	American Samoa
AD	Andorra
AO	Angola
AI	Anguilla
AG	Antigua & Barbuda
AR	Argentina
AM	Armenia
AU	Australia
AT	Austria
AZ	Azerbaijan
BS	Bahamas
BH	Bahrain
BD	Bangladesh
BB	Barbados
BY	Belarus
BE	Belgium
BZ	Belize
BJ	Benin
BM	Bermuda
BT	Bhutan
BO	Bolivia
BA	Bosnia & Herzegovina
BW	Botswana
BR	Brazil
VG	British Virgin Islands
BN	Brunei
BG	Bulgaria
BF	Burkina Faso
BI	Burundi
KH	Cambodia
CM	Cameroon
CA	Canada
CV	Cape Verde
KY	Cayman Islands
CF	Central African Republic
TD	Chad
CL	Chile
CN	China
CO	Colombia
KM	Comoros
CG	Congo - Brazzaville
CD	Congo - Kinshasa
CR	Costa Rica
CI	Côte d’Ivoire
HR	Croatia
CU	Cuba
CY	Cyprus
XA	Cyprus (North)
CZ	Czechia
DK	Denmark
DJ	Djibouti
DM	Dominica
DO	Dominican Republic
EC	Ecuador
EG	Egypt
SV	El Salvador
GQ	Equatorial Guinea
ER	Eritrea
EE	Estonia
SZ	Eswatini
ET	Ethiopia
FO	Faroe Islands
FJ	Fiji
FI	Finland
FR	France
GA	Gabon
GM	Gambia
GE	Georgia
DE	Germany
GH	Ghana
GI	Gibraltar
GR	Greece
GL	Greenland
GD	Grenada
GT	Guatemala
GG	Guernsey
GN	Guinea
GW	Guinea-Bissau
GY	Guyana
HT	Haiti
HN	Honduras
HK	Hong Kong SAR China
HU	Hungary
IS	Iceland
IN	India
ID	Indonesia
IR	Iran
IQ	Iraq
IE	Ireland
IM	Isle of Man
IL	Israel
IT	Italy
JM	Jamaica
JP	Japan
JE	Jersey
JO	Jordan
KZ	Kazakhstan
KE	Kenya
KI	Kiribati
XK	Kosovo
KW	Kuwait
KG	Kyrgyzstan
LA	Laos
LV	Latvia
LB	Lebanon
LS	Lesotho
LR	Liberia
LY	Libya
LI	Liechtenstein
LT	Lithuania
LU	Luxembourg
MO	Macao SAR China
MG	Madagascar
MW	Malawi
MY	Malaysia
MV	Maldives
ML	Mali
MT	Malta
MH	Marshall Islands
MR	Mauritania
MU	Mauritius
MX	Mexico
FM	Micronesia
MD	Moldova
MC	Monaco
MN	Mongolia
ME	Montenegro
MS	Montserrat
MA	Morocco
MZ	Mozambique
MM	Myanmar (Burma)
NA	Namibia
NR	Nauru
NP	Nepal
NL	Netherlands
NC	New Caledonia
NZ	New Zealand
NI	Nicaragua
NE	Niger
NG	Nigeria
KP	North Korea
MK	North Macedonia
NO	Norway
OM	Oman
PK	Pakistan
PW	Palau
PS	Palestine
PA	Panama
PG	Papua New Guinea
PY	Paraguay
PE	Peru
PH	Philippines
PL	Poland
PT	Portugal
QA	Qatar
RO	Romania
RU	Russia
RW	Rwanda
WS	Samoa
SM	San Marino
ST	São Tomé & Príncipe
SA	Saudi Arabia
SN	Senegal
RS	Serbia
SC	Seychelles
SL	Sierra Leone
SG	Singapore
SK	Slovakia
SI	Slovenia
SB	Solomon Islands
SO	Somalia
ZA	South Africa
KR	South Korea
SS	South Sudan
ES	Spain
LK	Sri Lanka
SH	St. Helena
KN	St. Kitts & Nevis
LC	St. Lucia
VC	St. Vincent & Grenadines
SD	Sudan
SR	Suriname
SE	Sweden
CH	Switzerland
SY	Syria
TW	Taiwan
TJ	Tajikistan
TZ	Tanzania
TH	Thailand
TL	Timor-Leste
TG	Togo
TO	Tonga
TT	Trinidad & Tobago
TN	Tunisia
TR	Türkiye
TM	Turkmenistan
TC	Turks & Caicos Islands
TV	Tuvalu
UG	Uganda
UA	Ukraine
AE	United Arab Emirates
GB	United Kingdom
US	United States
UY	Uruguay
UZ	Uzbekistan
VU	Vanuatu
VA	Vatican City
VE	Venezuela
VN	Vietnam
EH	Western Sahara
YE	Yemen
ZM	Zambia
ZW	Zimbabwe

Configure task templates

Mon, 01 Jan 0001 00:00:00 +0000

Tasks assigned to applicants are generated from task templates. A task template aggregates basic task settings, including task statuses, deadlines, email notification and document attachment options.

Each task template includes several statuses that represent the applicant’s progress. Task statuses help track task completion and provide clarity for both applicants and the admission team. You can tailor the set of statuses within each template to fit the specific workflow of that task.

Consent (global)

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single consent configured in the system. For a consent associated with a specific applicant, see Consent.

URI

/api/v9/applicants/consents/ID

Get a consent

Get information about a specific consent in the system.

Syntax

GET /api/v9/applicants/consents/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applicants/consents/1"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1456`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The consent exists
`400 Bad Request`	The consent ID was not valid
`404 Not Found`	The consent was not found

Example response

Response

 
 
 
{
 "type": "Mandatory",
 "text": "I agree to the terms and conditions of data processing",
 "link": "https://apply.example.edu/terms"
}

Create scoresheets

Mon, 01 Jan 0001 00:00:00 +0000

To start evaluating applicants, you need to create scoresheets in DreamApply. Each scoresheet focuses on a single assessment area, for example, language proficiency or academic performance.

Before you begin

To create scoresheets, your account must have the Superuser role or the scorers permission with access to all scoresheets.

Add scoresheets

To add scoresheets:

In the main menu, under Scoring, select Scoresheets.
At the bottom of the list, click New scoresheet.

Create trackers

Mon, 01 Jan 0001 00:00:00 +0000

In most cases, you create trackers at the time you assign them — for example, when you import leads or assign trackers manually through applicant cards. In some cases, however, the tracker must already exist before you can use it. These applies to:

Trackers assigned by applicants as reference codes
Trackers linked to entry points
Trackers used in rules
Trackers assigned to leads imported from external systems

Before you begin

To manage trackers, your account must have the Superuser, Admissions administrator or Marketing administrator role or the trackers permission.

Customize the portal identity and branding

Mon, 01 Jan 0001 00:00:00 +0000

You can customize the main aspects of your portal identity — its name and domain — and personalize the look and feel to align with your organization’s brand.

Identity and branding settings are configured at the instance level. They apply to the Administrator, applicant and advisor portals. In the multi-institution setup, these settings affect all institutions and their respective portals.

Before you begin

To customize the portal identity and branding settings, your account must have the Superuser role or the instance permission.

Data collection basics

Mon, 01 Jan 0001 00:00:00 +0000

During the admission process, DreamApply collects different types of data at different stages. To ensure clarity and trust, it is important to understand:

What types of data DreamApply collects
Who is responsible for managing this data
What options applicants and institutions have to handle this data

Roles and responsibilities

In DreamApply, data collection responsibilities are divided between the platform and an institution:

DreamApply acts as a data processor. It operates the admission management system, delivers authentication, account management and application processing functions and tools.
An institution acts as a data controller. It decides what applicant data is collected during the admission process, defines how this data is used and how long it is retained.

In short, DreamApply provides the platform, while the institution decides the scope and purpose of data use.

Define applicant categories

Mon, 01 Jan 0001 00:00:00 +0000

To support different admission paths for various groups of applicants, you can use applicant categories. Applicant categories help customize the application process based on factors like the applicant’s residency or background.

DreamApply includes the following predefined categories:

Domestic
International
Alumni

Institutions can customize this list by adding or removing categories as needed.

How applicant categories are used

Applicant categories can be used to manage the following areas:

Intake eligibility: You can configure intakes to be available only to specific categories. Applicants who do not belong to an eligible category will not see programmes linked to those intakes.
Appform customization: You can create different question sets and assign additional appforms to specific categories.
Automatic rules: You can define rules that trigger based on applicant categories.
Record filtering: Administrators can filter applications and other records by category to simplify processing and reporting.

Category visibility modes

Visibility modes control how categories are assigned and whether applicants can see and select them.

Entry point basics

Mon, 01 Jan 0001 00:00:00 +0000

Entry points are special URLs generated by DreamApply. Institutions can place these URLs in their marketing materials to track which campaigns bring users to the DreamApply portal.

When a user clicks such a URL, DreamApply captures the tracking data and then immediately redirects them to their intended webpage or content. Depending on how the entry point is configured, the destination can be:

Page in the DreamApply portal
External URL

All tracking statistics on entry points is collected in DreamApply. With it, institutions can monitor campaign effectiveness and understand how users arrive at DreamApply.

Export data to a spreadsheet

Mon, 01 Jan 0001 00:00:00 +0000

Assume we want to automatically export applicant data to Google Sheets whenever a specific flag is assigned to an application in DreamApply. To do this, we will create a connection between DreamApply and Google Sheets through Zapier and configure a workflow that will automatically write applicant data to a spreadsheet.

Before you begin

Make sure your account has the Superuser role.
Make sure you have a Zapier account.
Make sure you have a Google account.
Make sure you have created a spreadsheet in your Google Drive with the following columns: Applicant ID, Applicant given name, Applicant family name and Applicant email.

Step 1. Connect DreamApply to Zapier

First, we need to connect DreamApply to Zapier to be able to send event and application data.

Finance basics

Mon, 01 Jan 0001 00:00:00 +0000

The Finance module uses a set of components to support finance management. These components work together to cover all major financial operations such as fee collection, invoice generation, payment tracking and provide transparent and accurate billing.

Fees
Additional services
Invoices
VAT rules
Payment gateways
Grants and scholarships

Fees

In DreamApply, fees are charges associated with different stages of the admission process. They represent costs that applicants must pay to proceed with their application or get access to services such as tuition or accommodation.

Flag

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single flag assigned to the application. For a specific flag available in the system, see Flag (global).

URI

/api/v9/applications/ID/flags/ID

Get a flag

A request with the GET verb returns some additional information about the flag association (date assigned etc.). Use the HEAD verb to test if the application in question has this flag.

This request does not return the flag itself, but rather represents the relationships between the application and the flag. Follow the flag URI in the response to retrieve further information about the flag in question.

Flag (global)

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single flag set up in the system. For a flag assigned to a specific application, see Flag.

URI

/api/v9/applications/flags/ID

Get a flag

Use the HEAD verb to test if this flag exists. A request with the GET verb returns some additional information about the flag (e.g created date).

Syntax

GET /api/v9/applications/flags/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/flags/1"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response code	Description
`200 OK`	The flag data was successfully returned
`404 Not Found`	The flag does not exist

Example response

Response

 
 
 
{
 "id": 1,
 "created": "2025-03-14T13:28:51+00:00",
 "name": "Awaiting interview"
}

Delete a flag

Remove the flag from the system, also removing it from all applications.

Getting started with Textile

Mon, 01 Jan 0001 00:00:00 +0000

Assume you want to add content to the main page of the DreamApply portal. Textile will help you highlight key points, organize requirements and guide applicants through their next steps.

Step 1. Locate the front-segment

DreamApply uses templates to display content across the portal, including portal pages, invoice blueprints and system emails. The content displayed under the top banner on the main page is controlled by the front-segment template.

Grants and scholarships basics

Mon, 01 Jan 0001 00:00:00 +0000

To manage budgets and assign financial aid to eligible candidates, you can use the Grants and scholarships view in DreamApply.

DreamApply does not serve as a financial platform for handling actual payments. Instead, it should be used as a planning and allocation tool. It helps institutions understand how funds can be potentially distributed to candidates, forecast expenses and prepare structured data for use in external budgeting or payment platforms.

Budgets

A budget represents a specific amount of institutional funds allocated for a particular purpose. For example, an institution can define the Top Achievers budget for high-performing candidates or the International Students Support budget to offer financial aid to applicants from abroad.

Headings

Mon, 01 Jan 0001 00:00:00 +0000

To create headings, start a line with the heading tag, h1 through h6, followed by a period.

Heading formatting

 Textile
 
h1. Heading level 1

h2. Heading level 2

h3. Heading level 3

h4. Heading level 4

h5. Heading level 5 

h6. Heading level 6

Heading formatting

 HTML
 
<h1>Heading level 1</h1>

<h2>Heading level 2</h2>

<h3>Heading level 3</h3>

<h4>Heading level 4</h4>

<h5>Heading level 5</h5>

<h6>Heading level 6</h6>

How data transfer works

Mon, 01 Jan 0001 00:00:00 +0000

To integrate DreamApply with ESSE3, an institution must collaborate with DreamApply and Cineca.

Data transfer between DreamApply and ESSE3 is an ongoing process that includes the following stages:

Data transfer: ESSE3 periodically polls DreamApply to fetch a list of new applications in the DreamApply portal. For each new application, ESSE3 fetches essential information, including applicant personal details, uploaded documents, applied programmes and the application ID. The retrieved data is stored in the ESSE3 platform.

How gateway payments work

Mon, 01 Jan 0001 00:00:00 +0000

When an applicant clicks the payment button on a financial document in DreamApply, the following actions are performed:

DreamApply collects the necessary information to initiate the transaction such as the payment amount, description and securely redirects an applicant to the external payment portal.
An applicant selects a preferred payment method offered by the payment gateway.
DreamApply sends a payment request to the payment gateway.
The payment gateway initiates a transaction based on the selected payment method and processes the payment. As part of this process, it generates an external ID to track the transaction.

How Google integration works

Mon, 01 Jan 0001 00:00:00 +0000

To integrate with Google Analytics and Google Tag Manager, you need to enter the tracking ID in the system settings of DreamApply. DreamApply integrates with Google products through:

Google Analytics: Measurement ID for a data stream, for example: G-XXXXXXXXXX
Google Tag Manager: Container ID, for example: GTM-XXXXXXX

DreamApply automatically injects the required tracking script into the DreamApply portal. DreamApply uses gtag.js — a single global tag that sends data to several Google services:

How incoming integrations work

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate DreamApply with third-party CRM systems, such as Microsoft Dynamics 365, Salesforce and Smarthub, to automatically import lead data to DreamApply.

DreamApply supports continuous integration with CRM systems. Once the integration is set up, DreamApply checks the CRM environment for newly created or updated records with a 1-minute interval. If matching records are detected, DreamApply securely fetches the lead data and registers them as leads in the system.

How Matomo integration works

Mon, 01 Jan 0001 00:00:00 +0000

To integrate with Matomo, you need to enter the Matomo URL and site ID in the system settings of DreamApply.

Once the integration is set up, DreamApply automatically injects the required tracking script into the DreamApply portal. The script collects user interaction data, such as page views, button clicks and file downloads, and sends it to Matomo. It also captures user details, such as geographical location, device type and browser details. As a result, you can monitor and analyze this data in Matomo dashboards.

How outgoing integrations work

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply supports outgoing integrations with external marketing tools such as CRM platforms and mailing systems. Outgoing integrations allow you to send applicant data to those systems, where you can manage and communicate with applicants further.

Applicant data export

When you set up an integration gateway, DreamApply exports applicant data and creates new records — such as leads, contacts or subscribers — in the connected system. Depending on the system, created records are assigned to contact owners or placed into the selected group/audience.

How Zapier integration works

Mon, 01 Jan 0001 00:00:00 +0000

Zapier acts as a bridge between DreamApply and third-party applications. To automate workflows, it uses Zaps — simple connections between two or more applications that run automatically when certain events occur.

Each Zap consists of a trigger and one or more actions:

A trigger is an event in DreamApply that starts an automated workflow.
An action is a task that Zapier performs in a connected application. For example, the action can add a row to a Google sheet, update a user record in HubSpot or send a notification to Slack.

Once you set up an automated workflow in Zapier, it runs automatically in the background. No manual input or monitoring is required.

ID conventions

Mon, 01 Jan 0001 00:00:00 +0000

All resources have unique numeric IDs, such as applicant ID, application ID, tracker ID and institution ID.

IDs carry no meaning or information
IDs are permanent and will never change
There may be gaps between IDs
Deleted IDs are never reused

Some resources have unique properties, such as a tracker code or a flag name. While these properties uniquely identify a resource, they cannot be used as IDs. These properties may change over time, and an ID must remain constant throughout the life of the resource.

Interview basics

Mon, 01 Jan 0001 00:00:00 +0000

To assess applicants beyond their applications, you can use video interviews. Interviews can be helpful if you want to:

Evaluate communication skills
Assess problem-solving abilities
Review task performance without use of AI or chatbots
Determine overall applicant suitability

In DreamApply, interviews are governed by scenarios. A scenario defines:

The list of questions an applicant must answer
The number of attempts allowed
Deadline, reminders and other related settings

When an applicant is invited to an interview, DreamApply automatically links their application to the interview and sends a message with a link to the interview to the applicant. The applicant can access the interview through the link, complete and submit responses within the defined deadlines.

Invoice

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single invoice for the application.

URI

/api/v9/applications/ID/invoices/ID

Due to GDPR regulations, it is possible to delete applicants from the system, for example with the Right to be forgotten tool, batch purge (by academic term) or with an individual applicant record deletion.

However, in order to not destroy accounting records, invoices are the only data that is preserved after an applicant record is destroyed. To achieve this, invoices are detached from the applicant records, losing this association. This is why in the admin UI they are distinctive with a gray “anonymous” icon and also why in the API response the applicant and application field is set to null.

Manage access to meetings

Mon, 01 Jan 0001 00:00:00 +0000

To let Administrators efficiently schedule meetings and events, you must assign roles and permissions to them.

Administrators require the Content administrator role to view and schedule meetings. We recommend that you grant this role to all Administrators responsible for meetings and events. This approach ensures comprehensive access to all required tasks and resources and reduces complexity.

To assign additional meeting tasks to Administrators, you can use the following permissions:

campus: Allows Administrators to set up and manage buildings and rooms for meetings
meetings-edit: Allows Administrators to create, edit and delete meetings
meetings-view: Allows Administrators to access the Meetings view in DreamApply, view meeting schedules and their details
meetings-registrations-view: Allows Administrators to view a list of registered participants
meetings-registrations-edit: Allows Administrators to edit participant registrations: change time slots, delete registrations

Superusers have all meetings permissions enabled by default. All admins that had the previous events permission will automatically receive the new meetings-view and meetings-edit permissions. The same goes for all Administrator roles; they will be updated accordingly.

Manage fees

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, fees represent charges linked to specific programmes. You can set up various types of fees, define their amounts and geographical variations.

To define which fee must be applied, DreamApply uses the territory hierarchy. It checks for a fee starting from the most specific territory and moves up to more general levels. For example:

If a specific fee is set for a country, that fee will be applied for applicants whose citizenship is set to that country.
If no fee is set for a country, the system checks the region to which the country belongs.
If no regional fee is found, the system applies the global (World) fee.

You can mark a fee as visible or hidden. All visible fees for a programme are displayed in the fees section on the programme description page.

Messaging modes

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply offers two modes to organize communication with applicants:

Regular messaging mode: Recommended for informational or automated communication
Two-way messaging mode: Supports interactive conversations for continuous communication with applicants

You can enable two-way messaging in the system settings in DreamApply.

Regular messaging mode

Use the regular messaging mode if your institution plans to send informational or automated messages to applicants and further interaction is typically not required.

In this mode, applicants receive automated email messages from DreamApply directly in their email inboxes and can also view them in the Messages view of the portal. If an applicant chooses to reply using their email client, the response is sent as a standard message to the external email address specified in the Reply-to field.

Offer basics

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, offers represent key decisions that Administrators make while reviewing and evaluating applications. Offers allow institutions to model the entire application process and establish a clear, customizable workflow through which applications must progress.

Offer workflows

The offer process is organized by priority. This allows you to individually manage and track each programme an applicant selects.

When an applicant adds programmes to their application, DreamApply saves the selected programmes as priorities. Once the application is submitted, DreamApply creates a separate offer for each priority, assigns a unique offer ID to it and links the offer to the corresponding priority.

Offer letter

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single offer letter.

Syntax

/api/v9/applications/ID/offers/ID/letters/ID
Host: apply.example.edu
Authorization: DREAM apikey="..."

Get an offer letter

Fetch the metadata associated with an offer attachment. Currently this API request is only provided for the sake of completeness. It is likely easier to fetch the entire list using GET /api/v9/applications/ID/offers/ID/letters as currently this API request does not offer any additional data beyond the data already available in the listing.

Offer note

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single offer note.

URI

/api/v9/applications/ID/offers/ID/notes/ID

Get an offer note

A request with the GET verb returns information about one specific (sticky) note on the offer record.

Syntax

GET /api/v9/applications/123/offers/321/notes/123
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/offers/321/notes/123"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The note was successfully returned
`404 Not Found`	The note was not found

Example response

Response

 
 
 
{
 "created": "2025-12-10T11:55:57+00:00",
 "removed": null,
 "colour": "Salmon",
 "pinned": false,
 "collapsed": false,
 "notes": "Need to receive updated proof of financial support documents"
}

Response

"Need to receive updated proof of financial support documents"

Edit an offer note

Update a specific offer (sticky) note.

Organize applications

Mon, 01 Jan 0001 00:00:00 +0000

Before starting the review process, you can define how applications must be organized and managed in DreamApply. As part of this process, you can:

Set application limits
Group applications

Before you begin

To configure application settings, your account must have the Superuser role or the instance permission.

Set application limits

You can control how many priorities applicants can choose when applying. This option helps maintain a manageable number of choices per applicant and encourages them to focus on their most relevant ones.

Organize invoices

Mon, 01 Jan 0001 00:00:00 +0000

To keep your invoices organized and trackable in the system, you can set up invoice series. This feature ensures that all invoice numbers follow a clear, consistent format, which helps in maintaining better records.

Invoice series are optional in DreamApply. If you do set up a custom invoice series, DreamApply will use its default series to generate invoices. The default series uses a simple auto-incrementing numeric sequence without a prefix.

Purge applications

Mon, 01 Jan 0001 00:00:00 +0000

To keep application data clean and organized, you can use the Data purging option. Data purging allows Administrators to remove outdated applications and data that are no longer needed. This option can be especially helpful to prepare the system for new submissions when the previous academic term ends and a new term begins.

Data purging is performed per academic term. DreamApply deletes all applications within the term as well as system resources linked to them, such as offers, priorities and interviews. Applicant accounts and DreamID records remain in the system, so applicants can use them to submit new applications for upcoming terms.

Ranking basics

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply allows you to create one or more ranking lists in the Rankings view. Each ranking list can have its own filters and selection logic. For example, you can create dedicated ranking lists for specific programmes, academic terms or applicant groups.

In DreamApply, a ranking list is built around offers. DreamApply presents offers as individual entries in the list.

When an applicant adds a programme to their application, DreamApply saves the selected programme as a priority and creates an offer for it. Initially, every new offer gets the Unreplied type. As the application progresses through the admission process, Administrators update the offer type to reflect their evaluation decision.

Reference

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single reference submitted for the application.

URI

/api/v9/applications/ID/references/ID

Get a reference

Retrieve information about a particular reference submitted for the application.

Syntax

GET /api/v9/applications/123/references/321
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/references/321"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The reference was successfully returned
`404 Not Found`	The reference was not found

Example response

Response

 
 
 
{
 "id": 1,
 "invited": "2026-02-17T11:15:03+00:00",
 "accessed": "2026-02-17T11:19:05+00:00",
 "committed": "2026-02-17T11:19:18+00:00",
 "invitation": {
 "name": "Sarah Tyler",
 "email": "sarah.tyler@email.com"
 },
 "data": {
 "referee": {
 "name": "Linda Jason"
 },
 "evaluation": {
 "essay": "It is a pleasure to recommend Linda Jason, a candidate who stands out through her sharp analytical mindset and exceptional interpersonal maturity.\n\nAcademic and Professional Excellence\nLinda possesses a remarkable ability to transform complex data into actionable strategies. During her tenure, she spearheaded a cross-departmental project that improved efficiency by 20%, demonstrating a \"first-principles\" approach to problem-solving. She doesn't just execute tasks; she optimizes them, consistently delivering high-quality results under tight deadlines.\n\nPersonal Characteristics\nWhat truly differentiates Linda is her emotional intelligence and leadership style. She is a natural \"bridge-builder\" who maintains a calm, grounded demeanor even in high-pressure environments. Linda balances a high standard of accountability with genuine empathy, making her a vital asset to any collaborative team. Her intellectual humility and eagerness to grow ensure she will be a standout contributor to your program."
 }
 }
}

Scoring basics

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply uses a set of components to score applications:

Scoresheets
Automatic conversions
Evaluation criteria

These components work together in a step-by-step workflow where each step contributes to calculating final scores and ranking candidates.

Scoresheets

Scoresheets are the foundation of the scoring process. They are used to evaluate and assign points to applicants based on specific criteria. Each scoresheet focuses on a single assessment area, for example, language proficiency or academic performance.

Select the instance type

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply supports two setup options for institutions:

Single-institution instance: This setup is recommended for organizations operating as a single entity, such as smaller schools, colleges or universities with a centralized structure. All departments and programmes are managed within one institution in DreamApply.
Multi-institution instance: This setup is designed for larger organizations or federations that comprise multiple institutions. Each institution maintains its own academic structure, departments, programmes and admission processes while operating within a single DreamApply instance.

Tracking basics

Mon, 01 Jan 0001 00:00:00 +0000

The Marketing module in DreamApply is designed to work with leads. It allows marketing teams to monitor how applicants arrive at DreamApply and assess the effectiveness of their marketing efforts.

Leads

In DreamApply, leads are users who have registered or been collected through different channels but have not yet started their applications. These users are considered early-stage prospects and are not yet part of the main application workflow.

Leads do not have active applications, and Administrators cannot manage them through the main portal views and tools. To help institutions track these users, DreamApply provides a dedicated Leads view. This view shows how many leads have registered and how they are progressing to becoming applicants.

Types of reminders

Mon, 01 Jan 0001 00:00:00 +0000

Reminder / notification	Trigger	Frequency	Silenced
Welcome email	Registration completed	Sent once	No
Welcome email (imported applicant)	Applicant (lead) imported	Sent once	No
Welcome email (event registration)	Applicant registered to participate in an event	Sent once	No
Event registration cancellation	Applicant registration cancelled	Sent once	No
Draft application	Application in Draft status 3 days before the intake deadline	Every day before the deadline	No
Inactive application	Application in Draft status unedited for 15 days	Sent once	No
Reopened application	Application reopened and unedited for 3 days	Every 10 days, max 3 times	Yes
Final decision	Confirmed accepted offer exists	Weekly or biweekly; stops after decision or 2 months	Yes
Final decision confirmation	Applicant makes final decision	Sent once	No
Invoice delivery	Invoice issued	Sent once	No
Invoice reminder	Unpaid invoice, < 3 days to deadline	Sent once	No
Invoice collection	Invoice marked as collected	Sent once	No
Referee invitation	Referee added	Initial + one reminder after 10 days	No
Referee thank-you	Reference submitted	Sent once	No
Applicant notification (reference)	Reference submitted	Sent once	No
Task reminders	Task pending in active application	Configurable; max duration 6 months	Yes

Welcome email

Sent immediately after the registration to confirm access, provide joining instructions and welcome the applicant.

Understanding application data

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply uses different types of resources to organize, display and manage application data. To interact with this data through both the DreamApply UI and its API, it is important to understand these resources and how they relate to each other.

Applicants

When a user account is registered in the system, DreamApply creates an applicant record and assigns a unique applicant ID to it. There are several ways user accounts can be registered:

Use entry points (static redirects)

Mon, 01 Jan 0001 00:00:00 +0000

Assume that you are running a social media campaign for Fall admissions. Your goals are:

Track how many applicants come from the Fall campaign materials
When users click campaign links, send them to the Programme search page in DreamApply
Attribute leads in DreamApply

Before you begin

Make sure your account has the Superuser role. In a real case, roles can be configured differently.

Step 1. Create a tracker

First, we will create a tracker in DreamApply to identify leads who register as part of the Fall campaign.

User roles

Mon, 01 Jan 0001 00:00:00 +0000

The DreamApply portal is designed for different types of users that take part in the admission process:

Website visitors
Applicants
Administrators
Advisors

Each user role controls which functional areas users can access, what data they can view and edit and what actions they can take.

DreamApply does not offer a separate mechanism for managing user roles. All website users are considered website visitors until they log in to the system. Once logged in, DreamApply dynamically assigns users one of roles based on their credentials and actions.

UTM parameter basics

Mon, 01 Jan 0001 00:00:00 +0000

If your campaign materials contain URLs that bring users to the DreamApply portal and you want to track campaign effectiveness, you can add UTM parameters to these URLs.

DreamApply supports standard UTM parameters:

utm_id
utm_source
utm_medium
utm_campaign
utm_term
utm_content

Custom UTM parameters are not supported. For details, see UTM parameters.

For example, to track leads coming from the Fall2025 campaign on Facebook, you can add the utm_source and utm_campaign parameters to the URL:

ZIP archive

Mon, 01 Jan 0001 00:00:00 +0000

Represents a ZIP archive with all documents attached to an application.

URI

/api/v9/applications/ID/documents/zip

Download attached documents

Retrieve all documents attached to an application as a ZIP archive (binary data).

DreamApply organizes the ZIP archive using the following rules:

Source retrieval: The archive includes documents uploaded via the Documents section of the application edit page and those uploaded via tasks (including active and trashed tasks). Task-related files are placed in folders named after the specific task.
Duplicate file names: If multiple files have the same name, DreamApply appends a unique suffix to differentiate them.
PDF previews: For PDF files with 9 or fewer pages, DreamApply automatically generates JPEG previews — one preview file per PDF page. By default, the ZIP archive includes both the original PDF files and previews. To download only the original PDF files without previews, use the skip-extracted-pages parameter.

You can also download documents attached to a specific task. For details, see GET api/applications/ID/tasks/ID/documents/zip.

ZIP archive

Mon, 01 Jan 0001 00:00:00 +0000

Represents a ZIP archive with all documents attached to a task.

URI

/api/v9/applications/ID/tasks/ID/documents/zip

Download attached documents

Retrieve all documents attached to a task as a ZIP archive (binary data).

DreamApply organizes the ZIP archive using the following rules:

Task status: DreamApply retrieves documents attached to both active and trashed tasks.
Duplicate file names: If multiple files have the same name, DreamApply appends a unique suffix to differentiate them.
PDF previews: For PDF files with 9 or fewer pages, DreamApply automatically generates JPEG previews — one preview file per PDF page. By default, the ZIP archive includes both the original PDF files and previews. To download only the original PDF files without previews, use the skip-extracted-pages parameter.

You can also download all documents attached to an application. For details, see GET /api/v9/applications/ID/documents/zip.

Academic terms

Mon, 01 Jan 0001 00:00:00 +0000

Academic terms, or terms, represent academic periods during which actual studies and classes take place at the institution.

Terms enable institutions to organize and schedule their academic calendars in DreamApply. For example, if your institution follows a semester-based model with a Fall semester and Spring semester each year, you must create corresponding terms in DreamApply. This setup is typically done once a year to prepare the system for the upcoming academic cycle.

Academic year

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single academic year.

URI

/api/v9/academic-years/year

Get an academic year

List academic years configured into the system. These in turn academic terms.

An academic year does not have to align with the calendar year, so it may also have a name like 2017/18 when it spans, for instance, from September to September.

Syntax

GET /api/v9/academic-years/2025
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/academic-years/2025"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The academic year data was successfully returned
`404 Not Found`	The academic year was not found

Example response

Response

{
 "name": "2025/26",
 "start": "2025-09-01"
}

Administrator

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single administrator in the system.

URI

/api/v9/administrators/ID

Get an administrator

Retrieve the administrator data.

Syntax

GET /api/v9/administrators/123
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/administrators/123"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The administrator data was successfully returned
`404 Not Found`	The admin was not found

Example response

Response

 
 
 
{
 "id": 10001,
 "name": "John Smith",
 "email": "j.smith@email.com",
 "phone": "+32 472 85 1234",
 "function": "Admissions administrator"
 "roles": [
 {
 "id": 2,
 "name": "Admissions administrator"
 },
 {
 "id": 7,
 "name": "Courses administrator"
 }
 ]
}

Advisor permission levels

Mon, 01 Jan 0001 00:00:00 +0000

Depending on their granted permissions, Advisor access levels can range from incognito access to full application management. Use the table below to understand what capabilities are available to Advisors with different permission levels.

Capability	Ability to manage applications, offers, tasks	Full read-only access to applications	Limited access	Incognito access
Account management
Register applicant accounts	✅	✅ If Allowed to register new applicants is enabled	✅ If Allowed to register new applicants is enabled	✅ If Allowed to register new applicants is enabled
Register applicant accounts without an email address	✅ If Allowed to register applicants without an email is enabled	❌	❌	❌
Change applicant email address (for unverified accounts)	✅	❌	❌	❌
Send a verification reminder	✅	❌	❌	❌
Application management
View application statistics	✅	✅	✅	✅
View applications	✅	✅	✅ Only applicant's name, photo, region, programmes and application statuses	✅ Only applicant IDs, programmes and application statuses
Edit applications	✅	❌	❌	❌
Withdraw applications	✅	❌	❌	❌
Process payments	✅	❌	❌	❌
Complete tasks	✅	❌	❌	❌
Confirm offers	✅	❌	❌	❌
View messages in the portal	✅	❌	❌	❌
Receive applicant's emails (CC)	✅ If CC applicant emails to the advisor is enabled	❌	❌	❌

AI integration basics

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply provides access to AI-powered features through AI Highlighter. AI Highlighter integrates DreamApply with third-party Large Language Models (LLMs) and allows Administrators to perform admission tasks with the help of AI.

AI Highlighter can assist Administrators with the following tasks:

Data summarization: Generate concise summaries of application data
Document parsing and data extraction: Identify and extract key information from application data and uploaded documents
Classification and labeling: Analyze application data to automatically categorize and label applications based on specific criteria
Validation and consistency checking: Detect discrepancies or inconsistencies in applications
Text translation: Translate application materials into the institution’s primary language
AI-driven image verification: Automatically identify and analyze uploaded images, such as passport photos

Treat AI Highlighter as a helper, not a decision-maker. Administrators themselves remain responsible for interpreting AI responses and making final decisions. Always trace the AI reasoning trail that AI Highlighter displays for each AI output and verify it against the original documents. For details, see View AI responses.

LLM-based data processing

DreamApply does not develop or host its own AI models. Instead, it integrates with third-party LLMs to process application data.

Analytics tools comparison

Mon, 01 Jan 0001 00:00:00 +0000

The table below lists analytics tools supported by DreamApply and compares their use, hosting options, pricing, prerequisites and key pros and cons.

Tool	Privacy Level & Core Value	Hosting Location	Pricing/ Prerequisites	Overview
Google Analytics (GA4), Google Tag Manager (GTM)	GDPR via Anonymization. Core Value: Complex and tailored analytics for professional use.	Global SaaS	Freemium ($0 tier)	Pros: Granular IDs, funnels. Cons: Complex, 48h delay in data display.
Matomo	High — full GDPR compliance, self-hosting option. Core value: Data sovereignty & privacy.	EU Cloud (Germany) or self-hosted anywhere	Free (self-hosted), requires own server for self-host, or paid (cloud).	Pros: Privacy-first, open-source, full data ownership, robust features, GDPR-compliant. Cons: More complex to configure than lightweight tools.
Fathom	High — no cookies, GDPR compliant. Core value: Simplicity & GDPR compliance.	US/EU (dual-region hosting)	Free (self-hosted), requires own server for self-host, or paid (cloud).	Pros: Simple, privacy-focused, no cookies, real-time metrics, GDPR-compliant. Cons: Limited advanced features, aggregate-only, not for detailed user-level tracking.
Plausible	High — open-source, GDPR, CCPA and PECR compliant, EU-hosted. Core value: Lightweight & privacy-first.	EU Cloud (Germany) or self-hosted	Free (self-hosted), requires own server for self-host, or paid (cloud).	Pros: Privacy-first, fast-loading, minimal interface, open-source, GDPR-compliant. Cons: Not designed for complex and advanced reporting, aggregate-only, not for detailed user-level tracking.
Simple Analytics	High — no personal data, GDPR compliant. Core value: API access, clean UI & privacy.	EU Cloud (Netherlands)	Paid (cloud); no self-hosting.	Pros: Privacy-first, minimalist dashboard, strong API access, easy for marketing teams, GDPR-compliant. Cons: Limited features, aggregate-only, not for detailed user-level tracking.

Appform basics

Mon, 01 Jan 0001 00:00:00 +0000

To collect information from applicants on the application edit page, you can configure and combine several sources. While applicants see a single, unified form, DreamApply builds it from several components:

Programme-specific appforms
Additional appforms
Inherent appform

The application edit page can also include programme-specific requirements configured for each programme in the catalog. For details, see Define application form settings.

Programme-specific appforms

The structure of the application edit page is primarily defined by a programme-specific appform. This appform includes a standard set of sections and fields that applicants must complete. You can use this appform to collect common information that applies across multiple programmes.

Application freezing

Mon, 01 Jan 0001 00:00:00 +0000

Represents a resource that allows freezing an application.

URI

/api/v9/applications/ID/freeze

Freeze an application

Freeze the application data to prevent further changes by the applicant.

When an application is frozen, the existing scores on the scoresheets to which the application is added are also frozen and cannot be edited by an applicant. Administrators can still update the application data and scores through the administrative portal.

Assign trackers

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply offers several ways to assign trackers:

By Administrators
By applicants
By Advisors
Through entry points
Automatically through rules
While importing leads
Via the DreamApply API

Before you begin

To assign trackers, your account must have the Superuser or Admissions administrator role or the applicants-view and applicants-edit permissions.
To set up automatic rules, your account must have the Superuser role or the rules permissions.
To subscribe to journal events, your account must have the Superuser or Admissions administrator role or the journal-view and journal-edit permissions.

Manually assign trackers (by Administrators)

Administrators can manually assign trackers to applicants through applicant cards. This method is useful if Administrators are aware that an applicant is participating in a specific campaign or was referred by a particular Advisor.

Authentication and security

Mon, 01 Jan 0001 00:00:00 +0000

HTTPS

The first prerequisite for securing the API is HTTPS, which is automatically enabled for all DreamApply instances.

HTTPS is HTTP over TLS. TLS provides both confidentiality and integrity for transmitted data ensured through mechanisms such as HMAC.

Because all API communication occurs over a secure channel, the DreamApply API design can remain simpler. For example, DreamApply does not require a complicated custom HMAC scheme (as used by some APIs, such as Amazon Web Services) or additional mechanisms, such as transmitting nonces with each request to prevent replay attacks.

Authentication and sessions

Mon, 01 Jan 0001 00:00:00 +0000

Users with different roles can log in to the DreamApply portal in the following ways:

Applicants: In the top right corner of the DreamApply portal, click Sign in/Register. On the mobile version, in the top left corner, click the main menu icon and select Sign in/register.
Administrators: In the bottom left corner of the menu, click Admin login (on both desktop and mobile versions).
Advisors: In the bottom left corner of the menu, click Advisor login (on both desktop and mobile versions).

Session management

When a user logs in to DreamApply, they are granted a session, which allows them to perform actions associated with their assigned role.

Calculate the ranking score

Mon, 01 Jan 0001 00:00:00 +0000

The Score column in the Rankings view displays the ranking score calculated for each offer. To calculate ranking scores, DreamApply uses scores from scoresheets that are further processed using the rules defined in the evaluation criteria.

When analyzing ranking scores, you can:

View the calculation breakdown
Add extra points
Recalculate ranking scores

Before you begin

To work with ranking scores, your account must have the Superuser, Admissions administrator or Academic supervisor role or the offers-scoring permission.

Countries

Mon, 01 Jan 0001 00:00:00 +0000

The following list of countries is used throughout the platform whenever location information is required. DreamApply relies on the ISO 3166-1 alpha-2 codes standard. In addition, it includes a limited number of temporary country codes for regions and territories not officially assigned ISO codes, such as Kosovo and Northern Cyprus.

Code	Country Name
AF	Afghanistan
AX	Åland Islands
AL	Albania
DZ	Algeria
AS	American Samoa
AD	Andorra
AO	Angola
AI	Anguilla
AG	Antigua & Barbuda
AR	Argentina
AM	Armenia
AW	Aruba
AU	Australia
AT	Austria
AZ	Azerbaijan
BS	Bahamas
BH	Bahrain
BD	Bangladesh
BB	Barbados
BY	Belarus
BE	Belgium
BZ	Belize
BJ	Benin
BM	Bermuda
BT	Bhutan
BO	Bolivia
BA	Bosnia & Herzegovina
BW	Botswana
BV	Bouvet Island
BR	Brazil
IO	British Indian Ocean Territory
VG	British Virgin Islands
BN	Brunei
BG	Bulgaria
BF	Burkina Faso
BI	Burundi
KH	Cambodia
CM	Cameroon
CA	Canada
CV	Cape Verde
BQ	Caribbean Netherlands
KY	Cayman Islands
CF	Central African Republic
TD	Chad
CL	Chile
CN	China
CX	Christmas Island
CC	Cocos (Keeling) Islands
CO	Colombia
KM	Comoros
CG	Congo - Brazzaville
CD	Congo - Kinshasa
CK	Cook Islands
CR	Costa Rica
CI	Côte d’Ivoire
HR	Croatia
CU	Cuba
CW	Curaçao
CY	Cyprus
XA	Cyprus (North)
CZ	Czechia
DK	Denmark
DJ	Djibouti
DM	Dominica
DO	Dominican Republic
EC	Ecuador
EG	Egypt
SV	El Salvador
GQ	Equatorial Guinea
ER	Eritrea
EE	Estonia
SZ	Eswatini
ET	Ethiopia
FK	Falkland Islands
FO	Faroe Islands
FJ	Fiji
FI	Finland
FR	France
GF	French Guiana
PF	French Polynesia
TF	French Southern Territories
GA	Gabon
GM	Gambia
GE	Georgia
DE	Germany
GH	Ghana
GI	Gibraltar
GR	Greece
GL	Greenland
GD	Grenada
GP	Guadeloupe
GU	Guam
GT	Guatemala
GG	Guernsey
GN	Guinea
GW	Guinea-Bissau
GY	Guyana
HT	Haiti
HM	Heard & McDonald Islands
HN	Honduras
HK	Hong Kong SAR China
HU	Hungary
IS	Iceland
IN	India
ID	Indonesia
IR	Iran
IQ	Iraq
IE	Ireland
IM	Isle of Man
IL	Israel
IT	Italy
JM	Jamaica
JP	Japan
JE	Jersey
JO	Jordan
KZ	Kazakhstan
KE	Kenya
KI	Kiribati
XK	Kosovo
KW	Kuwait
KG	Kyrgyzstan
LA	Laos
LV	Latvia
LB	Lebanon
LS	Lesotho
LR	Liberia
LY	Libya
LI	Liechtenstein
LT	Lithuania
LU	Luxembourg
MO	Macao SAR China
MG	Madagascar
MW	Malawi
MY	Malaysia
MV	Maldives
ML	Mali
MT	Malta
MH	Marshall Islands
MQ	Martinique
MR	Mauritania
MU	Mauritius
YT	Mayotte
MX	Mexico
FM	Micronesia
MD	Moldova
MC	Monaco
MN	Mongolia
ME	Montenegro
MS	Montserrat
MA	Morocco
MZ	Mozambique
MM	Myanmar (Burma)
NA	Namibia
NR	Nauru
NP	Nepal
NL	Netherlands
NC	New Caledonia
NZ	New Zealand
NI	Nicaragua
NE	Niger
NG	Nigeria
NU	Niue
NF	Norfolk Island
KP	North Korea
MK	North Macedonia
MP	Northern Mariana Islands
NO	Norway
OM	Oman
PK	Pakistan
PW	Palau
PS	Palestine
PA	Panama
PG	Papua New Guinea
PY	Paraguay
PE	Peru
PH	Philippines
PN	Pitcairn Islands
PL	Poland
PT	Portugal
PR	Puerto Rico
QA	Qatar
RE	Réunion
RO	Romania
RU	Russia
RW	Rwanda
WS	Samoa
SM	San Marino
ST	São Tomé & Príncipe
SA	Saudi Arabia
SN	Senegal
RS	Serbia
SC	Seychelles
SL	Sierra Leone
SG	Singapore
SX	Sint Maarten
SK	Slovakia
SI	Slovenia
SB	Solomon Islands
SO	Somalia
ZA	South Africa
GS	South Georgia & South Sandwich Islands
KR	South Korea
SS	South Sudan
ES	Spain
LK	Sri Lanka
BL	St. Barthélemy
SH	St. Helena
KN	St. Kitts & Nevis
LC	St. Lucia
MF	St. Martin
PM	St. Pierre & Miquelon
VC	St. Vincent & Grenadines
SD	Sudan
SR	Suriname
SJ	Svalbard & Jan Mayen
SE	Sweden
CH	Switzerland
SY	Syria
TW	Taiwan
TJ	Tajikistan
TZ	Tanzania
TH	Thailand
TL	Timor-Leste
TG	Togo
TK	Tokelau
TO	Tonga
TT	Trinidad & Tobago
TN	Tunisia
TR	Türkiye
TM	Turkmenistan
TC	Turks & Caicos Islands
TV	Tuvalu
UM	U.S. Outlying Islands
VI	U.S. Virgin Islands
UG	Uganda
UA	Ukraine
AE	United Arab Emirates
GB	United Kingdom
US	United States
UY	Uruguay
UZ	Uzbekistan
VU	Vanuatu
VA	Vatican City
VE	Venezuela
VN	Vietnam
WF	Wallis & Futuna
EH	Western Sahara
YE	Yemen
ZM	Zambia
ZW	Zimbabwe

Course

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single course added to the catalog.

URI

/api/v9/courses/ID

Get a course

Return information about a course, identified by the course’s ID.

Syntax

GET /api/v9/courses/123
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/courses/123"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The course data was successfully returned
`404 Not Found`	The course was not found

Example response

Response

 
 
 
{
 "id": 16,
 "status": "Online",
 "updated": "2025-10-28T07:13:25+00:00",
 "institution": "/api/v9/institutions/1",
 "intakes": {
 "9": "/api/v9/intakes/9",
 "10": "/api/v9/intakes/10"
 },
 "featured": true,
 "type": "UG",
 "awards": [
 {
 "abbr": "BSc",
 "full": "Bachelor of Science"
 }
 ],
 "name": "Data Structures and Algorithms",
 "mode": "FT",
 "duration": "2 years",
 "credits": "18.0",
 "language": "en~de",
 "country": "BE",
 "location": "Antwerp",
 "code": "IT100",
 "accreditation": "01/01/2023 until 31/12/2028",
 "quota": 150,
 "prospect": {
 "uri": "engtech.edu/cs"
 },
 "department": "/api/v9/institutions/1/departments/4"
}

Create programme-specific appforms

Mon, 01 Jan 0001 00:00:00 +0000

To set up a standard set of sections and fields that applicants must complete, you need to create one or more programme-specific appforms and link them to programmes.

DreamApply comes with a set of predefined appform sections. Each section includes data entry fields that you can activate and display to applicants. If a suitable question is not available, you can add your own data entry fields. If some section or data entry field is not required, you can exclude it.

Create tables

Mon, 01 Jan 0001 00:00:00 +0000

You can create tables in DreamApply to explore and share specific segments of application data.

Column types

To build a table, select the columns you want to display based on your reporting needs. DreamApply offers the following types of columns to help you organize information:

Metadata columns: Display core system data such as Applicant, Application, Assignees, Created date or Submitted date. Use these fields as the foundation for your table views to track and manage application information.
Data columns: Show application-related data such as offer details, profile and contact information.
Custom columns: Editable columns that support manual data entry. Custom columns can be used to capture notes, labels or additional information, without affecting the system application data.

Row structure

Depending on the columns you select, DreamApply supports two row structures:

Define budgets

Mon, 01 Jan 0001 00:00:00 +0000

Depending how your institution plans to allocate funds, you can define one or more budgets for each financial year. For example, you can use a single consolidated budget to manage all grants and scholarships of the year. Alternalivery, you can set up separate budgets for different purposes.

Each budget reflects a specific amount of institutional funds and can be linked to one or more grants or scholarships. When you assign grants and scholarships to candidates, the allocated amounts are drawn from the corresponding linked budget.

Define roles for reviewers

Mon, 01 Jan 0001 00:00:00 +0000

To ensure each admission team member has the appropriate level of access and can work with relevant applications, they must have an Administrator account created for them and be granted the appropriate role.

DreamApply offers several built-in roles that make it easy to quickly set up access rights for reviewers:

Admissions administrator: Can work with applications, confirm offers and perform other application-related tasks.
Academic supervisor: Has read-only access to applications plus the ability to add flags, score applications, and edit offers.
Academic consultant: Has read-only access to applications.

You can combine several roles or create your own roles if needed. In addition, you can grant granular permissions to Administrators to extend built-in roles. Note, however, that assigning roles is a recommended way to manage access in DreamApply as they simplify permission management and reduce the risk of errors.

Delete applicant accounts

Mon, 01 Jan 0001 00:00:00 +0000

Applicants or Administrators may want to remove applicant accounts from DreamApply. This can happen when:

An applicant wants to withdraw from all of their applications
An applicant wants remove their account but still wants to keep their DreamID for possible future use
An Administrator needs to remove an applicant account on behalf of the applicant

When an applicant account is deleted, DreamApply removes all data and resources for that account. This includes:

Department

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single department under the institution.

URI

/api/v9/institutions/ID/departments/ID

Get a department

Retrieve information about a particular institution department.

Syntax

GET /api/v9/institutions/123/departments/321
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/institutions/123/departments/321"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The department data was successfully returned
`404 Not Found`	The department was not found

Example response

Response

 
 
 
{
 "id": 1,
 "name": "Department of Mechanical Engineering",
 "country": "BE",
 "location": "Antwerp",
 "www": "https://engtech.edu/me"
}

Document

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single applicant document (binary data).

URI

/api/v9/applications/ID/documents/ID

Get a document

Retrieve the document (binary) data.

Syntax

GET /api/v9/applications/123/documents/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/documents/1"

Response headers

Header	Value	Description
`Content-Type`	`image/jpeg`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`Last-Modified`	`2025-05-16T14:59:53+00:00`	Date and time when the document was last modified

Response codes

Response code	Description
`200 OK`	The binary data of the document was successfully returned
`404 Not Found`	This document does not belong to this application

Document

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single document attached to the task.

URI

/api/v9/applications/ID/tasks/ID/documents/ID

Get a document

Retrieve the document (binary) data.

Syntax

GET /api/v9/applications/123/tasks/321/documents/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/tasks/321/documents/1"

Response headers

Header	Value	Description
`Content-Type`	`image/jpeg`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`Last-Modified`	`2025-05-16T14:59:53+00:00`	Date and time when the document was last modified

Response codes

Response code	Description
`200 OK`	The binary data of the document was successfully returned
`404 Not Found`	This document does not belong to this task

DreamApply Accessibility Conformance Report (WCAG Edition)

Mon, 01 Jan 0001 00:00:00 +0000

Report Date: April 2025

Product description: Applicant and application management system for schools, universities, or other academic institutions

Contact Information: hello@dreamapply.com

Document Scope

The scope of this report is limited to the following user scenarios and pages:

User Scenarios

Applicant registration
User account self-management
Searching institutions+browse programmes
Creating, filling, and submitting applications
Managing tasks, uploading documents
Finding and registering with a meeting

Evaluation methods used

axe, NVDA via Google Chrome

DreamApply basics

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply is an admission system designed to manage all aspects of student enrollment. It provides a centralized solution to handle each stage of the admission process, from application submission to student onboarding.

DreamApply does not replicate traditional institution processes and paperwork. Instead, it lets institutions set up a custom digital workflow that aligns with their admission policies and operational requirements. With DreamApply, institutions can streamline and automate important parts of the process, including:

Event list

Mon, 01 Jan 0001 00:00:00 +0000

Event Category	Event	Description
Applicant	Applicant registered	A new applicant account was created
	Applicant was deleted	Applicant account was soft-deleted
	Applicant decision: ?	Applicant made a decision (accept/reject offer etc.)
	Applicant requested to be forgotten	Applicant issued a Right to be Forgotten request
	Applicant email was changed	Applicant contact email was changed (applicant themself or by an admin)
	Applicant was transferred to another DreamID identity	This can be carried out by ad administrator to restore applicant access
Applicant trackers	Tracker was added	A marketing tracker was added to an applicant/lead
Applicant trackers	Tracker was removed	A marketing tracker was removed from an applicant/lead
Application	Application was created	New application was created (applicant can have several applications)
	Application was created by cloning	New application was created by cloning another application
	Application was edited	Application was saved
	Course was added to application	Should be self-explanatory
	Course was removed from application	Should be self-explanatory
Application submit	Application was submitted	Application was submitted successfully
Application submit	Application was re-submitted	Application was submitted after being reopened previously
Application assign	Application was assigned	Application was assigned to an administrator for handling (manually or via Director)
Application assign	Application was un-assigned	Application was un-assigned from an administrator
Application flags	Application was flagged	A flag was added to the application
Application flags	Application was un-flagged	A flag was removed to the application
Application management	Application was reopened	Application was reopened for applicant to make changes
	Application was silenced	Reminders were stopped regarding an application
	Application was un-silenced	Reminders were re-activated
	Application was frozen	Application does not accept further edits by applicant
	Application was defrosted	Applicant is again editable for the applicant
	Application was migrated	Application was migrated to a different year/intake
	Application was withdrawn	Application was withdrawn by the applicant
	Application was closed	Application was soft-deleted
	Application was reverted	Application soft-deletion was reverted (undelete)
	Application was marked as inactive	Application was not touched for a long time..
Application references	Referee was added to an application	Referee was added to an application
Application references	Referee was removed from an application	Referee was removed from an application
Application sharing	Application was shared with: ?	A share access was issued for an application
Application sharing	Application share was revoked	A share access was revoked for an application
Offers and replies	Offer was edited: ?	Offer contents were changed
Offers and replies	Offer was confirmed: ?	Offer was sent out
Documents	Document was uploaded	A document was uploaded
Documents	Document was uploaded to a task	A document was uploaded to a checklist task
Media files	Media was uploaded	A media file was uploaded directly to DreamApply
	Media was added	A 3rd party media Media (YouTube, SoundCloud, Vimeo, ..) was added
	Media was removed	A 3rd party media Media (YouTube, SoundCloud, Vimeo, ..) was removed
Interviews	Interview was started	A video interview was started by applicant
	Interview was completed	A video interview was completed by applicant
	Interview was evaluated	A video interview was evaluated by administrator
References	Referee was invited	A referee was invited to submit a reference
	Referee was reminded	A reminder (one and only) was sent to the referee
	Referee committed reference	Referee finished the reference for an applicant
Invoices	Invoice was issued	A new invoice was issued (the first "Save" operation)
	Invoice was edited	An invoice was edited (the subsequent "Save" operations)
	Invoice was deleted	An invoice was deleted
	Invoice was reminded	A payment reminder was sent in relation to an invoice
	Invoice was marked as paid	Funds were collected regarding an invoice (may be partially collected)
Tasks	Task was committed as: ?	Task status was changed but not yet resolved
	Task was resolved as: ?	Task status was changed to a status that is "successful"
	Task was commented	Comments field was changed on a task

Fee amount

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single fee amount.

URI

/api/v9/fees/ID/amounts/TerritoryName

Get a fee amount

Return information about a fee amount specified for a specific territory.

As a territory identifier, use an ISO 3166-1 alpha-2 country code or 001 to retrieve the global (worldwide) fee amount.

Syntax

GET /api/v9/fees/123/amounts/001
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/fees/123/amounts/001"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource

Response codes

Response code	Description
`200 OK`	The amount data was successfully returned
`404 Not Found`	The fee was not found

Example response

Response

 
 
 
{
 "qualifier": null,
 "currency": "EUR",
 "amount": "1100.00",
 "info": "",
 "basis": "Year"
}

Filters

Mon, 01 Jan 0001 00:00:00 +0000

To narrow down the list of application records, you can use filters in DreamApply. Filters allow you to focus on specific admission data without the need to manually search through large datasets.

Filters adapt to the context of each view, for example:

In the Browse view, you can filter data using criteria related to applications, applicants, offers, interviews and more.
In the Invoices view, you can filter data using applicant- and invoice-related criteria.

When you apply filters in one view, they remain active across other views in DreamApply, as long as those views support the same filtering criteria. This provides a unified and consistent experience across the system.

How webhooks work

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply uses webhooks to communicate with clients in the following way:

The client subscribes to specific events and sets up a webhook in DreamApply.
When a subscribed event occurs, DreamApply prepares a payload containing event information and related data. The payload uses the same format as the GET /api/journal request.
DreamApply sends a POST request with the payload to the client’s webhook endpoint.
The client receives the data and performs an action, for example, triggers a workflow.
The client returns a success status code to DreamApply to confirm receipt.

Webhook endpoint

To receive event data in JSON format, you must set up an HTTP endpoint that can handle POST requests.

Intake

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single intake configured in the system.

URI

/api/v9/intakes/ID

Get an intake

Get the details of the intake in question.

All dates (for example deadlines) are configured using ISO date notation, but skipping the year part as the intake system is designed to automatically roll over to the next year when appropriate. For this reason, dates are normally specified as 0000-MM-DD, for example 0000-04-23.

Integrate tasks with third-party systems

Mon, 01 Jan 0001 00:00:00 +0000

You can create task templates that allow applicants to interact with external systems and services. These interactions can range from simple actions like visiting a website or downloading a file from external storage, to more complex processes such as digitally signing documents or completing financial transactions on other platforms.

How tasks with external actions work

To create a task template with an external action, you need to add a button to the template settings that triggers the action. When an applicant clicks the button, DreamApply will redirect them to the specified URL.

Integrate with Brevo

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate DreamApply with Brevo to export applicant data. DreamApply sends the following data:

Email address
Full name
Location/citizenship
Phone number (if entered correctly with the country code)
Language preference (if available)

The exported data is registered as contact records in Brevo and added to the selected list.

To export applicant data, perform the following tasks:

Obtain an API key
Configure integration settings

Before you begin

To integrate with DreamApply, your account must have the Superuser role or the integrations permission.

Integrate with Cobra CRM

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate DreamApply with Cobra CRM to export applicant data and create new contact records.

DreamApply can send the following data:

Applicant data: ID, name, first name, last name, email, phone, registration date, citizenship
Lead data: Lead stage and stage change date
Offer data: ID, date, priority, name, programme ID, programme code, programme name, institution ID, institution name and abbreviation
Academic term data: Name, year, type and start date
Dates: Dates and UTC dates values

To export applicant data, perform the following tasks:

Integrate with ESSE3

Mon, 01 Jan 0001 00:00:00 +0000

To enable data transfer between DreamApply and ESSE3, perform the following tasks:

Request the ESSE3 add-on
Map programme data
Indicate documents to be transferred
Implement data retrieval
Customize the welcome email template

Request the ESSE add-on

The ESSE3 integration functionality is available as an add-on provided at no charge. To activate the add-on and properly set up your DreamApply instance, contact the DreamApply team.

Provide the following information to the DreamApply team:

Integrate with Google Analytics

Mon, 01 Jan 0001 00:00:00 +0000

Google Analytics is a web analytics service that collects and reports data about user interactions with websites and apps. You can use it to understand user behavior in the DreamApply portal, measure traffic and evaluate performance of the DreamApply pages.

To integrate with Google Analytics, perform the following tasks:

Get the Measurement ID
Configure integration settings
Configure consent settings

Before you begin

Make sure you have a Google Analytics account.
To integrate with DreamApply, your account must have the Superuser role or the instance permission.

Get the Measurement ID

You need to create a data stream in Google Analytics and get a Measurement ID for this stream. The Measurement ID is a unique identifier that links DreamApply to a specific GA4 property and tells Google Analytics where to send data collected with gtag.js.

Integrate with Matomo

Mon, 01 Jan 0001 00:00:00 +0000

To integrate with Matomo, perform the following tasks:

Get the Matomo instance details
Configure integration settings
Configure consent settings

Before you begin

Make sure you have set up a Matomo instance in the cloud or on-premise.
To integrate with DreamApply, your account must have the Superuser role or the instance permission.

Get the Matomo instance details

To connect to Matomo, you need to obtain a Matomo URL and site ID.

Integrate with Microsoft Dynamics 365

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply utilizes the Microsoft Dynamics 365 Customer Engagement Web API to integrate with Microsoft Dynamics 365.

During the import process, it pulls the following data:

First name
Last name
Email address
Phone number and other available fields

You can map each lead field to the corresponding fields in the applicant records in DreamApply.

To import lead data to DreamApply, perform the following tasks:

Create an app registration in Microsoft Entra ID
Create an application user
Configure integration settings

Before you begin

To integrate with DreamApply, your account must have the Superuser role or the integrations permission.

Invoice transaction

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single invoice transaction.

URI

/api/v9/invoices/ID/transactions/ID

Get a transaction

Return information about a transaction, identified by the invoice ID and the transaction ID.

Syntax

GET /api/v9/invoices/123/transactions/12345
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/invoices/123/transactions/12345"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The transaction data was successfully returned
`404 Not Found`	The transaction was not found

Example response

Response

 
 
 
{
 "id": 44,
 "amount": "15.00",
 "invoice": "/api/v9/invoices/532",
 "inserted": "2025-12-16T09:57:11+00:00",
 "collected": "2025-12-16",
 "administrator": null,
 "payment": {
 "payment": "01KCK9DZXPE8C82F5AE0AV955F",
 "external_id": "pi_3Sev0C3BsCbItDpn0rx0zvsW",
 "status": "captured",
 "message": null,
 "inserted": "2025-12-16T09:56:28+00:00",
 "updated": "2025-12-16T09:57:11+00:00",
 "gateway": {
 "id": 39,
 "name": "Stripe",
 "adapter": "Stripe"
 }
 }
}

Manage access to offers

Mon, 01 Jan 0001 00:00:00 +0000

To let Administrators efficiently work with offers, you must assign roles and permissions to them and grant them access to specific offer types. As a result, each Administrator can focus on the offer types relevant to their role or responsibility. For example, one Administrator may review early-stage decisions, while another may be responsible for finalizing accepted offers.

Before you begin

To manage access to offers, your account must have the Superuser role or the administrators permission.

Manage access to programmes

Mon, 01 Jan 0001 00:00:00 +0000

To let Administrators efficiently work with the programme catalog, you must assign roles and permissions to them and grant them access to specific programmes.

Before you begin

To manage access to programmes, your account must have the Superuser role or the administrators permission.

Assign roles and permissions

Administrators require the Courses administrator role to work with programmes. This role grants a full set of permissions to set up the programme catalog and gives access to all related resources, including:

Manage access to scoresheets

Mon, 01 Jan 0001 00:00:00 +0000

You must assign roles and permissions to Administrators and grant them access to specific scoresheets.

Before you begin

To manage access to scoresheets, your account must have the Superuser role or the administrators permission.

Assign roles and permissions

Administrators require the Admissions administrator role to view and enter scores in applications. We recommend that you grant this role to all Administrators involved in the evaluation process.

To assign additional scoring tasks to Administrators, you can use the following permissions:

Manage Administrator accounts

Mon, 01 Jan 0001 00:00:00 +0000

You need to set up an Administrator account for each member of the admission team. Each Administrator must be granted appropriate roles, permissions and resource access policies.

Before you begin

To set up Administrator accounts, your account must have the Superuser role or the administrator permission.
To change the login email address for Administrator accounts, your account must have the Superuser role.

Administrators cannot assign privileges that exceed their own access level. They can grant only the roles, permissions and resource access that they personally possess.

Offer type

Mon, 01 Jan 0001 00:00:00 +0000

Represents the type of the application offer.

URI

/api/v9/applications/ID/offers/ID/type

Get the offer type

A request with the GET verb returns the offer type about the application offer in question.

Syntax

GET /api/v9/applications/123/offers/321/type
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/offers/321/type"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The offer type was successfully returned
`404 Not Found`	The application does not have this offer

Example response

Response

{
 "id": 12,
 "type": "/api/v4/applications/offers/types/12"
}

Response

"Conditionally accepted"

Set the offer type

Set the offer type to the application offer (identified by its ID) in question. This will check if the given type is a valid offer type that can be used in the system. On successful validation of the given type, it will be assigned as the type of the application offer in question.

Offer type

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single offer type.

URI

/api/v9/applications/offers/types/ID

Get an offer type

Retrieve information about an offer type.

This request is supported in API version 4 and later.

Syntax

GET /api/v9/applications/offers/types/123
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/offers/types/123"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The offer type data was successfully returned
`404 Not Found`	The offer type was not found

Example response

Response

 
 
 
{
 "id": 123,
 "status": "Online",
 "title": "Feedback",
 "colour": "#FF5599",
 "ranking": "Pending",
 "bcc": [],
 "confirm": 1,
 "freeze": null,
 "decide": null,
 "decline": null,
 "reopen": null,
 "silence": null,
 "subject": "Reply Feedback",
 "comments": "Dear %applicant-Name%,\n\nYou have received feedback from %institution-Name% regarding %course-FullName%\n\nPlease do not reply to this message.",
 "reasons": null
}

Paragraphs

Mon, 01 Jan 0001 00:00:00 +0000

To create paragraphs, add plain text separated by a blank line.

Paragraph formatting

 Textile
 
This is a paragraph.

This is another paragraph.

HTML-formatted text

 HTML
 
<p>This is a paragraph.</p>

<p>This is another paragraph.</p>

Personalize the front page

Mon, 01 Jan 0001 00:00:00 +0000

You can add custom content to the portal front page, such as:

Guidelines for applicants
Application tips
Welcome and motivational messages

This information appears directly below the main banner and institution names on the DreamApply portal.

In addition to the front page, you can customize pages for individual institutions and programmes with custom content and imagery. For details, see Set up an institution profile and Prepare and publish programmes.

Before you begin

To personalize the front page, your account must have the Superuser role or the templates permission.

Priority

Mon, 01 Jan 0001 00:00:00 +0000

Represents the applicant’s preference order for a course in an application.

URI

/api/v9/applications/ID/courses/ID/priority

Get the course priority

Get the priority level of a specific course in an application.

A value of 1 indicates the highest priority. Higher numerical values indicate lower priorities.

Syntax

GET /api/v9/applications/123/courses/1/priority
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/courses/1/priority"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response code	Description
`200 OK`	The priority data was successfully returned
`404 Not Found`	The application does not have this course

Example response

Response

1

Set the course priority

Sets the priority level for a course added to the application.

Send notifications to Slack

Mon, 01 Jan 0001 00:00:00 +0000

Assume the financial team wants to get notified whenever invoices are issued manually by Administrators, through rules or the API in DreamApply. To do this, we will create a connection between DreamApply and Slack through Zapier and configure a workflow that will automatically send notifications to a Slack channel.

Before you begin

Make sure your account has the Superuser role.
Make sure you have a Zapier account.
Make sure you have a Slack account, workspace and channel to which notifications must be sent.

Step 1. Connect DreamApply to Zapier

First, we need to connect DreamApply to Zapier to be able to send event and application data.

Set the institution time zone

Mon, 01 Jan 0001 00:00:00 +0000

To properly define the admission timeline, make sure the time zone in DreamApply is consistent with your institution’s time zone. If the time zone is set incorrectly, deadlines and scheduled events may appear inaccurately, leading to confusion for applicants and Administrators.

Before you begin

To configure time settings, your account must have the Superuser role or the instance permission.

Define the time zone

To set the time zone:

Set up AI prompts

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, prompts are set up centrally by Administrators with high-level privileges. Admissions administrators can only run approved prompts on selected applications; they cannot create or modify prompts themselves.

Centralized prompt creation ensures flexible AI support and minimizes the risk of accidental data exposure or misuse of the AI.

Before you begin

To create prompts, your account must have the Superuser role or the ai-prompts permission.

Create prompts

To create a prompt:

Set up interview scenarios

Mon, 01 Jan 0001 00:00:00 +0000

Before inviting applicants to interviews, you need to set up interview scenarios. A scenario is a guided flow presented to applicants in a step-by-step wizard format. Scenarios allow you to create a structured assessment process: before moving to the next step, an applicant must complete the previous one.

Before you begin

To create interview scenarios, your account must have the Superuser role or the interviews-scenarios permission.

Create interview scenarios

To create an interview scenario:

Set up invoice templates

Mon, 01 Jan 0001 00:00:00 +0000

To ensure all invoices follow a consistent format and include accurate financial details, you need to set up invoice templates. Well-prepared invoice templates streamline the invoicing process and help institutions maintain its branding guidelines.

Before you begin

To set up invoice templates, your account must have the Superuser or Accountant role or the accounting-view and accounting-edit permissions.

Define document types

You can define what types of financial documents your institution will use to support the invoicing process. Document types are specified in invoice templates, allowing institutions to accurately manage financial transactions. Common document types include invoices, proforma invoices, receipts and so on.

Set up landing pages

Mon, 01 Jan 0001 00:00:00 +0000

When users click campaign links, you often need to send them to a different destination, for example:

Programme catalog
Programme description page
External partner site

To capture clicks on these links and connect these clicks to registered applicants, you can set up landing pages in DreamApply.

How landing pages work

To set up a landing page, you need to create an entry point and configure the redirect behavior for it. The landing page acts as a tracker: it logs the user click, captures the entry point ID and then redirects the user to their final destination.

Set up meeting locations

Mon, 01 Jan 0001 00:00:00 +0000

To make sure meetings are well-organized and fully equipped, you should configure meeting locations in DreamApply. DreamApply allows you to set up and manage the following location types:

Buildings: Institution spaces, complexes or centers where multiple meetings can be hosted simultaneously
Rooms: Individual locations within a building tailored to a specific meeting size and format

Adding a location to a meeting is optional. You can skip this step for virtual meetings or if you prefer to include all details in the meeting description.

Set up VAT rules

Mon, 01 Jan 0001 00:00:00 +0000

To follow local tax laws and correctly calculate the charges on invoices, you need to set up VAT (Value Added Tax) rules in DreamApply. When an invoice is created, DreamApply adds the VAT amount to the total fee and shows it as a separate line on all receipts and invoices generated by the system.

To define which VAT rate must be applied, DreamApply uses the territory hierarchy. It checks for a rate starting from the most specific territory and moves up to more general levels. For example:

Silence reminders

Mon, 01 Jan 0001 00:00:00 +0000

Applicants and administrators can silence reminders for specific applications when notifications are no longer relevant or require attention later. Silencing reminders stops notifications until they are manually re-enabled or until the selected silence period expires.

DreamApply applies the following rules when silencing reminders:

Eligible reminders: Only reminders configured as “silenceable” are affected. For details, see the summary table for reminders.
On-request reminders: Messages that are not tied to the application or are sent on request are not silenced.
Automatic reset: If an applicant starts a new application in a future admission cycle, reminders are automatically re-enabled for that application.

Reminders can be silenced in the following ways:

Specify institution details

Mon, 01 Jan 0001 00:00:00 +0000

When setting up institutions in DreamApply, you need to provide detailed information about your organization. Make sure the data you specify is comprehensive and accurate, as it will be used in:

DreamApply portal for applicants
Documents provided to applicants
Reports

Before you begin

To edit institution details, your account must have the Superuser role or the institutions permission.

Provide general information

You need to provide key information that defines your institution. If your organization operates in the multi-institution setup mode, make sure you enter accurate information for each institution within your organization.

Tabledata

Mon, 01 Jan 0001 00:00:00 +0000

Allows fetching CSV data from the tableview.

URI

/api/v9/tableviews/ID/tabledata

Get CSV data

The tableviews data as CSV. You may use the HEAD verb to see the size of the CSV data if you want to decide if it is worth downloading it.

This resource contains exactly the same data as the tableview in the GUI, also including any “custom fields” (filled by the admin).

Task status

Mon, 01 Jan 0001 00:00:00 +0000

Represents the application task status.

URI

/api/v9/applications/ID/tasks/ID/status

Get the task status

A request with the GET verb returns the status text about the application task in question.

Syntax

GET /api/v9/applications/123/tasks/1/status
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/tasks/1/status"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The status was successfully returned
`404 Not Found`	The application does not have this task

Example response

Response

"I am preparing the documents for submission."

Set the task status

Set a status to the application task (identified by its ID) in question. This will check if the given status is already defined in the application task’s definition, and in case it’s not defined, this will add the status to the application task in question.

Term type

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single academic term type.

URI

/api/v9/academic-terms/types/ID

Get a term type

List academic term types configured into the system. These are used to create different types of academic terms. In another way — term types are a finite list, terms themselves are created for each academic year.

Syntax

GET /api/v9/academic-terms/types/123
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/academic-terms/types/123"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The academic term data type was successfully returned
`404 Not Found`	The academic term type was not found

Example response

Response

{
 "name": "Fall semester"
}

Track button clicks with GTM

Mon, 01 Jan 0001 00:00:00 +0000

Each programme description page in DreamApply has the Share button that allows applicants to share the page link. Assume you want to track how many users click this button and on which programme pages these clicks occur.

To do this, we will integrate DreamApply with Google Tag Manager, set up a tag to capture this data and send it to Google Analytics for reporting.

Before you begin

Make sure your Administrator account in DreamApply has the Superuser role.
Make sure you have an account and container in Google Tag Manager. For details, see Create an account and container in the Google documentation.
Make sure you have an account and a data stream in Google Analytics. For details, see Add a data stream in the Google documentation.

Step 1. Integrate with Google Tag Manager

First, we need to connect DreamApply to Google Tag Manager.

Tracker (global)

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single tracker code configured in the system. For a specific tracker code assigned to a specific applicant, see Tracker.

URI

/api/v9/applicants/trackers/ID

Get a tracker

Get information about a specific tracker code currently available in the system.

Syntax

GET /api/v9/applicants/trackers/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applicants/trackers/1"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1456`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The tracker exists
`404 Not Found`	The tracker was not found

Example response

Response

 
 
 
{
 "id": 37,
 "created": "2025-07-29T12:53:20+00:00",
 "code": "DISCOUNT10",
 "notes": "Some notes",
 "reduction": {
 "reduction": "Percent",
 "percent": 10
 }
}

Delete a tracker

Remove the tracker code from the system, also removing it from all applicants.

Transaction

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single transaction.

URI

/api/v9/invoices/transactions/ID

Get a transaction

Return information about a transaction, identified by the transaction ID.

Syntax

GET /api/v9/invoices/transactions/12345
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/invoices/transactions/12345"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The transaction data was successfully returned
`404 Not Found`	The transaction was not found

Example response

Response

 
 
 
{
 "id": 29,
 "amount": "15.00",
 "invoice": "/api/v9/invoices/532",
 "inserted": "2025-12-16T09:57:11+00:00",
 "collected": "2025-12-16",
 "administrator": null,
 "payment": {
 "payment": "01KCK9DZXPE8C82F5AE0AV955F",
 "external_id": "pi_3Sev0C3BsCbItDpn0rx0zvsW",
 "status": "captured",
 "message": null,
 "inserted": "2025-12-16T09:56:28+00:00",
 "updated": "2025-12-16T09:57:11+00:00",
 "gateway": {
 "id": 39,
 "name": "Stripe",
 "adapter": "Stripe"
 }
 }
}

Update the portal menu

Mon, 01 Jan 0001 00:00:00 +0000

The main menu in the DreamApply portal initially includes links to features and tools provided by DreamApply. You can add your own items to the menu to offer additional resources and enhance the portal usability.

Custom menu items appear in the left menu of the portal, under the DreamApply menu items. They can include:

Pages with important information
Links to external resources
Downloadable documents

Before you begin

To customize the menu, your account must have the Superuser, Marketing administrator or Content administrator role or the contents permission.

Use entry points (dynamic redirects)

Mon, 01 Jan 0001 00:00:00 +0000

Assume that you are running a social media campaign for Fall admissions. You want to place campaign materials on several external portals, such as:

Institution website
Partner portal
Student forum

Your goals are:

Use a single entry point for the entire campaign
Compare the performance of each portal or website
Track campaign performance in DreamApply and external marketing platforms

Before you begin

Make sure your account has the Superuser role. In a real case, roles can be configured differently.

View UTM parameter statistics

Mon, 01 Jan 0001 00:00:00 +0000

You can view UTM parameter statistics through dedicated reporting sections in DreamApply:

UTM parameters: Provides information on captured UTM parameters and allows drilling down into the captured/attributed parameter breakdown.
Leads, Browse, Statistics, Tables, Tasks: Allow filtering records by UTM parameters.
Applicant card: Shows a list of UTM parameters attributed to the lead.

Add applications to scoresheets

Mon, 01 Jan 0001 00:00:00 +0000

To systematically assess submitted applications, you must add applications to scoresheets.

Applications can be added to scoresheets in the following ways:

Using criteria (recommended): Define specific evaluation criteria and assign them to programmes. When an applicant applies for a programme, DreamApply automatically adds their application to the relevant scoresheets that feed those criteria.
Using rules: Set up rules to automatically add applications to scoresheets based on specific requirements.
Manual adding: Administrators and applicants can manually add applications to scoresheets. This method is especially useful for unlisted scoresheets.

Application defrosting

Mon, 01 Jan 0001 00:00:00 +0000

Represents a resource that allows defrosting an application.

URI

/api/v9/applications/ID/unfreeze

Unfreeze an application

Unfreeze the application data to allow further changes by the applicant.

When an application is defrosted, the existing scores on the scoresheets to which the application is added are also defrosted and can be edited by the applicant.

To record the action, DreamApply creates the Application was defrosted journal event.

Syntax

POST /api/v9/applications/123/unfreeze
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X POST \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/unfreeze"

Response codes

Response code	Description
`201 Created`	The application was successfully defrosted
`404 Not Found`	The application was not found

Assign applications

Mon, 01 Jan 0001 00:00:00 +0000

To help the admission team focus on the applications they need to work on, you need to assign these applications to them. Application assignment makes it easier for the admission team to filter and manage their workload during the review process.

DreamApply provides several tools to automate application assignment. You can set up rules to both assign applications for initial review and move applications through the admission pipeline. For example, you can use the Director to initially assign applications to Admissions Administrators. Additionally, you can set up automatic rules to assign applications to accountants for payment processing once the review is finished. After payments are received, applications can be re-assigned to team members responsible for visas and so on.

Assign tasks

Mon, 01 Jan 0001 00:00:00 +0000

You can assign tasks in the following ways:

Through programmes
Using rules
Via the DreamApply API

Before you begin

To assign tasks through programmes, your account must have the Superuser role or the task-classes permission.
To set up automatic rules, your account must have the Superuser role or the rules permissions.

Assign tasks through programmes

You can select to assign tasks through programmes if you want to communicate programme-specific requirements to applicants.

Blob

Mon, 01 Jan 0001 00:00:00 +0000

Represents a downloadable file (blob) regarding the export.

URI

/api/v9/applications/ID/exports/ID/blobs/blob

Retrieve a downloadable file

Retrieve the blob (Binary Large OBject) that constitutes the actually exported data. This might be, for example, an exported PDF study contract.

This request is different in the sense that currently blob IDs are not integers (as per normal convention), but rather a unique string of potentially varying length. This may change at a future date.

Create Administrator roles

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply comes with a set of built-in roles for admission team members. Depending on the needs of your institution, you can create new Administrator roles to control access levels.

If necessary, you can also customize security policy settings for built-in roles. However, the scope of permissions for built-in roles cannot be changed.

Before you begin

To set up Administrator accounts, your account must have the Superuser role or the administrator permission.

DreamApply API collection

Mon, 01 Jan 0001 00:00:00 +0000

Exclude data from AI analysis

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply allows you to control which application data and documents are shared with the LLM for AI processing. You can exclude data using:

Appforms
Rules

Before you begin

To manage appforms, your account must have the Superuser or Courses administrator role or the appforms permission.
To set up rules, your account must have the Superuser role or the rules permissions.
To manage consents, your account must have the Superuser role or the consents permission.

Exclude appform sections

You can mark specific sections in appforms as containing sensitive data. In this case, DreamApply automatically excludes these sections from being sent to the LLM for all prompts across the system.

How transactional emails work

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply follows industry-standard best practices and takes all the necessary steps to ensure its emails are trustworthy and delivered successfully.

Email addressing

To ensure email security and reliable email delivery, DreamApply uses its authentication mechanism that complies with industry standards and email service providers’ requirements. This approach streamlines the email sending process and eliminates the need for complex setups.

DreamApply sends emails from its domain: dreamapply.com to prevent impersonation (email spoofing) and maintain high deliverability. Using arbitrary email addresses in the From field is not allowed. However, you can specify a custom Reply-to address to direct responses to a different email address.

Authentication mechanism

DreamApply handles the entire authentication process on its side and requires no setup on the institution part. The authentication mechanism is built around three key components that work together to ensure the email authenticity and security.

Inline text (bold, italic and other)

Mon, 01 Jan 0001 00:00:00 +0000

You can format inline text using the following text styles:

Bold text
Italic text
Mixed bold and italic text
Inserted and deleted text
Superscript and subscript text

Bold text

To use strong and bold text, wrap the text in single asterisks * or double asterisks **. To mark several characters within a word as strong or bold, use square brackets.

Strong and bold tags display text in a bold font by default in nearly all browsers.

Intakes

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, intakes are used to define the admission timeline for specific academic terms. They include all stages of the application process such as:

application submission,
review,
final decisions,

culminating in applicant enrollment. While academic terms indicate when students begin their studies, intakes capture all the steps that lead to that point.

Each intake targets a specific academic term and is linked to it. You can structure your admission workflow to include multiple intakes that target the same term. For example, you can have an Early intake, Primary intake and Late intake, all linked to the same term. Think of the term as a reservoir and each intake as a pipe that directs applicants toward it.

Integrate with Google Tag Manager

Mon, 01 Jan 0001 00:00:00 +0000

Google Tag Manager is a tag management system that allows marketing teams to add and update analytics, advertising and conversion tracking codes without modifying the monitored website.

To integrate with Google Tag Manager, perform the following tasks:

Get the Container ID
Configure integration settings
Configure consent settings

Adding an external tag manager will necessarily cause foreign code to run within the DreamApply system. The use of such external code invalidates several key security assumptions, and DreamApply may no longer be able to safeguard the security of your data. Please be mindful of the tags that you add and make sure that the authors of those tags can be trusted. For details, see Integration disclaimer.

Before you begin

Make sure you have a Google Tag Manager account.
To integrate with DreamApply, your account must have the Superuser role or the instance permission.

Get the Container ID

You need to create a container for your DreamApply portal in Google Tag Manager and get a Container ID for it.

Integrate with Matomo Tag Manager

Mon, 01 Jan 0001 00:00:00 +0000

Matomo Tag Manager is a free, open-source tag management system that allows you to manage and deploy tracking codes, scripts and marketing tags on the monitored website without modifying it. Unlike Google Tag Manager, Matomo Tag Manager is privacy-focused and can be fully self-hosted, which gives organizations full control over their data and does not require them to share it with third parties.

Integrate with Salesforce

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply utilizes the Connected apps framework to integrate with Salesforce. This framework allows external systems to securely connect and access Salesforce data using standard authentication and authorization methods.

During the import process, DreamApply imports the following data:

First name
Last name
Email address
Phone number and other available fields

You can map each lead field to the corresponding fields in the applicant records in DreamApply.

To import lead data to DreamApply, perform the following tasks:

Invite to an interview

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply offers several ways to invite applicants to interviews:

Through automatic rules: You can create a rule that will automatically invite applicants matching a specific criteria
Using bulk invitations: You can select several applicants and send invitations in a batch
Using individual invitations: You can invite specific applicants as needed

Before you begin

To set up automatic rules, your account must have the Superuser role or the rules permissions.
To invite applicants in bulk or individually, your account must have the Superuser, Admissions administrator, Academic supervisor or Academic consultant role or the applications-view permissions.

Invite applicants using rules

You can set up DreamApply to automatically invite applicants that match specific criteria. For example, you may want to automatically invite international applicants who require additional screening or applicants who have successfully submitted their documents using tasks.

Issue invoices

Mon, 01 Jan 0001 00:00:00 +0000

To provide applicants with official financial documents whenever they are required to pay fees or purchase additional services, institutions can generate invoices with DreamApply.

DreamApply supports two methods for issuing invoices:

Automated invoice issuing
Manual invoice issuing

Before you begin

To automate invoice generation and issue invoices manually, your account must have the Superuser or Accountant role or the accounting-view and accounting-edit permissions.

Automate invoice issuing

DreamApply can be set up to automatically generate invoices when predefined events occur, for example, an applicant makes an admission decision or purchases an additional service. This type of invoicing is recommended for standard, routine payments when immediate invoicing is needed without staff intervention.

Locale data source

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply adheres to the Unicode Common Locale Data Repository (CLDR) for localisation data. The CLDR is a widely accepted and standardised source for localisation information, maintained by a consortium of experts and stakeholders.

What Unicode CLDR contains

The Unicode CLDR is critical for the development of software. It provides consistent and accurate localisation data for more than 800 languages and 150 regions, including:

Locale-specific patterns: Formatting and parsing for dates, times, time zones, numbers, currency values and measurement units
Translations: Localized names for languages, scripts and countries
Metadata: Information regarding language scripts and country validity

This standardization ensures that software applications handle locale-specific data in a reliable and predictable manner. Major technology companies, such as Google, Apple, Microsoft and IBM, use the CLDR to ensure their applications work seamlessly across different regions.

Offer attachment download

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single offer attachment (the binary blob).

Syntax

/api/v9/applications/ID/offers/ID/attachments/ID/download
Host: apply.example.edu
Authorization: DREAM apikey="..."

Download an offer attachment

Download a specific attachment.

There are two major ways that an attachment can be created:

Uploading a file when composing the offer letter (this request returns the uploaded bytes verbatim)
Generating a PDF attachment from a letterhead [1].

In addition:

An attachment can be specified as part of an offer type, in which case it is attached automatically
An attachment can be posted from the API

Notes

Note [1]: Letterheads are document templates that can be used to generate attachments to offers. In reality, there is also a middle-step in that process — first a Letter is created from the Letterhead (and can be accessed using GET /api/v9/applications/ID/offers/ID/letters). Such a Letter represents a generated (and potentially user-customised) document, where each template marker has already been replaced by actual applicant data. For the purposes of attaching to an offer, the Letter is converted to a PDF and attached o an offer just like a regular uploaded PDF. All of this happens seamlessly in the UI, however, for the API the entire data model is explicitly shown.

Offer discounts

Mon, 01 Jan 0001 00:00:00 +0000

Assume your institution wants to provide a 10% discount on the application fee as part of a promotional campaign.

To do this, we will create a tracker that will function as a reference code. When users enter this code during registration or application, DreamApply will automatically apply the discount and show it on their invoice.

Before you begin

Make sure your account has the Superuser role. In a real case, roles can be configured differently.
Make sure at least one programme is properly set up in the programme catalog.
Make sure at least one invoice template and invoice series are properly set up in the Finance module.

Step 1. Create a tracker with a discount

First, we will create a tracker that will function as a reference code.

Offer subject

Mon, 01 Jan 0001 00:00:00 +0000

Represents the subject line of the application offer.

URI

/api/v9/applications/ID/offers/ID/subject

Get the offer subject

A request with the GET verb returns the offer letter subject line.

Syntax

GET /api/v9/applications/123/offers/321/subject
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/offers/321/subject"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The offer letter subject line was successfully returned
`404 Not Found`	The application does not have this offer

Example response

Response

"You are accepted to a study place"

Set the offer subject

Set the offer letter subject line to the application offer (identified by its ID).

Ordering and grouping events

Mon, 01 Jan 0001 00:00:00 +0000

The returned journal events are ordered chronologically, so that the oldest events come first and the most recent event is last. The order is guaranteed even if the events happened in the same second.

There is a hard limit of maximum 1024 records returned as the number of journal events can be very large indeed. If you receive 1024 records, it is most likely being limited.

In some events, the name contains wildcards in the form of a question mark ?. This is used to “group” some very similar events together, in cases where the only differentiating factor is the status that something was set to etc.

Personalized messaging

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply allows Administrators to send direct messages to applicants. This type of communication can be helpful to clarify requirements, provide additional guidance or address specific applicant queries.

Administrators can:

Send a message to an individual applicant
Send a message to multiple applicants

Before you begin

To enable the two-way messaging mode, your account must have the Superuser role or the instance permission.
To view messages in message threads, your account must have the Superuser, Admissions administrator, Academic supervisor, Academic consultant, Marketing administrator or Accountant or the applicants-view and applications-view permissions.
To create threads and send messages, your account must have the Superuser or Admissions administrator role or the applicants-view, applications-view and applicants-edit permission.

Enable two-way messaging

To send messages using the Messages view in DreamApply, you must first enable the two-way messaging mode. All sent and received messages are organized into threads, making it simple to track the conversation history.

Photo

Mon, 01 Jan 0001 00:00:00 +0000

Represents the applicant’s photo.

URI

/api/v9/applicants/ID/photo

Get a photo

Return the applicant’s photo data.

Syntax

GET /api/v9/applicants/123/photo
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Name	Required/Optional	Description	Notes
`size`	Optional	Requested transformed size of photo, possible values are `S`, `M`, `L`, `R`, `F`.	The default value is `F` which applies the existing transformations, while `R` can skip all transformations and return the raw image.

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 -o ~/Downloads/photo_123.jpeg \
 "https://apply.example.edu/api/v9/applicants/123/photo"

Response headers

Header	Value	Description
`Content-Type`	`image/jpeg`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The applicant’s binary photo was successfully returned
`404 Not Found`	The applicant does not have a photo

Plan document collection

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, you can collect documents from applicants in the following ways:

Using the application edit page
Using tasks

Each option supports different institution needs and creates a different experience for applicants.

Use the application edit page

Each programme in the catalog includes the Application form > Scanned documents settings. These settings add a requirement to upload scanned copies of documents using the form on the application edit page.

Points

Mon, 01 Jan 0001 00:00:00 +0000

Represents the points of the scoresheet score.

URI

/api/v9/scoresheets/ID/scores/ID/points

Get points

A request with the GET verb returns the score’s points as JSON encoded string (or null, if there are no points set). Note that 0 points is returned as “0” as it is a perfectly valid number of points.

Syntax

GET /api/v9/scoresheets/123/scores/321/points
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/scoresheets/123/scores/321/points"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The points value was successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"90.00"

Set points

Set the points of a scoresheet score to a particular value. This will still run all validation checks and will not permit illegal point values to be entered that fall out of the accepted range as set in the scoresheet settings. If setting mapped values (for example if 5 = Excellent), the numeric value must be sent.

Prepare and publish programmes

Mon, 01 Jan 0001 00:00:00 +0000

Institutions must create, regularly review and update their catalog in DreamApply. This helps applicants make informed decisions and ensures a smooth admission process.

We recommend programme cloning as a primary method of catalog setup. First, create a few base programmes. Then duplicate them and adjust programme-specific fields such as title, department, appforms, fees and intakes.

Before you begin

To set up the programme catalog, your account must have the Superuser or Courses administrator role or the courses-view and courses-edit permissions.

Request DreamID deletion

Mon, 01 Jan 0001 00:00:00 +0000

If an applicant wants to completely remove their presence from all DreamApply systems and portals, they can request to delete their DreamID. This action permanently deletes the DreamID record itself and all accounts linked to it.

Use this option with caution. After a DreamID is deleted, DreamApply cannot restore it.

When an applicant requests DreamID deletion, DreamApply removes the DreamID from the https://id.dreamapply.com/ portal and creates a data deletion request to remove the applicant account linked to the DreamID, including:

Response codes

Mon, 01 Jan 0001 00:00:00 +0000

The DreamApply API uses standard HTTP status codes to communicate the results of API requests. The codes below outline the general logic of status codes across the system. For more specific code meanings for individual API requests, see the API reference.

Success

Code	Description
`200 OK`	The generic success code.
`201 Created`	A typical response for the `POST` request. A new resource was created, and the response includes a reference to the created resource.
`204 No Content`	A typical response for `PUT` and `DELETE` requests. The response was completed, but there is no response body.

Error

Code	Description
`400 Bad Request`	The request parameters or body fail validation, for example, the ID is not in the correct format or some of the filtering parameters are invalid.
`401 Unauthorized`	The request authentication failed; the DreamApply API key is missing, expired or invalid. For details, see Authentication and security.
`404 Not Found`	A requested resource cannot be found. Typically indicates that the resource (generally identified by its ID) does not exist. If you issue multiple `DELETE` requests for the same resource, you will receive this error on any subsequent requests.
`409 Conflict`	A request cannot be completed due to a conflict, for example, a flag or tracker with the same ID already exists or an applicant with the same email address is already registered.
`429 Too Many Requests`	Too many requests were sent in a short period of time. For details, see API quota limits.
`500 Internal Server Error`	The server has encountered an error while processing the request. The issue is not caused by the client, and the client may retry the request. If the error persists for the same request, contact the DreamApply team with the request details.

Schedule meetings

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply allows scheduling both onsite and virtual meetings to meet the needs of your institution and participants.

For onsite meetings, you can select a room with the appropriate space and facilities from the configured locations.
For virtual meetings, you can create a meeting without a location and provide joining instructions in the meeting description. These instructions can direct participants to popular conferencing tools like Google Meet, Microsoft Teams, WebEx or Zoom, allowing them to join with a click.

You can schedule meetings with different registration requirements:

Send activation requests

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply offers two methods to send activation requests to ESSE3:

Automatic: DreamApply automatically triggers activation requests when specific events occur.
Manual: For more granular control, you can manually send activation requests for specific applications to ESSE3.

Send requests automatically

You can set up DreamApply to automatically send activation requests to ESSE when specific events occur in DreamApply.

In the main menu, under Automation, select Rules.
Below the rules list, click New rule and specify the rule name.
In the Trigger events section, select check boxes next to events that must trigger activation requests.
In the Action section, select the Send this application to be activated in Esse3 check box.
At the top of the form, click Save changes.

Send requests manually

You can review applications in DreamApply and manually send activation requests to ESSE3.

Set up departments

Mon, 01 Jan 0001 00:00:00 +0000

As part of the setup process, you can configure departments in DreamApply. Departments serve as primary organizational units or subdivisions within the institution. They represent specific disciplines or group related fields of study, such as Science, Art or Engineering.

Departments are optional in DreamApply and are used mostly for categorization purposes. If the administrative structure of your institution does not group by departments, you can skip this task.

To configure departments:

Set up grants and scholarships

Mon, 01 Jan 0001 00:00:00 +0000

To plan and model how funds can be allocated to applicants, you need to set up grants and scholarships in DreamApply.

Each grant or scholarship is defined as a set of proportional values paid during the year. You can choose from several payment types:

Fixed amount: For example, for monthly stipends.
Specific fee: To cover a portion of a particular fee such as partial tuition.
Specific fee type coverage: To cover a portion of all fees within a certain category such as examination fees.

In DreamApply, the distinction between grants and scholarships mainly serves for categorization and does not affect how funds are awarded to applicants.

Set up offer types

Mon, 01 Jan 0001 00:00:00 +0000

To start working with offers, you need to define offer types. Offer types represent distinct stages in the admission workflow, starting from initial submission up to final decision.

DreamApply comes with a predefined set of offer types. These types are carefully designed to cover common review stages. If necessary, you can add your own offer types or customize existing types.

Avoid changing the original purpose of the default offer types. If your institution needs to introduce a new offer type, create a new type instead of modifying an existing one. Minor adjustments, like updating the type title, color and offer letter templates, are allowed and expected.

Before you begin

To set up offer types, your account must have the Superuser role.

Set up the academic calendar

Mon, 01 Jan 0001 00:00:00 +0000

To set up an academic year in DreamApply, start by cloning the previous year. When you clone a year, DreamApply automatically increments the year by one and copies the structure of the original year.

After cloning, you can adjust the calendar to reflect your academic requirements and structure. As part of this process, you can:

Select the term type
Add terms

Before you begin

To set up the academic calendar, your account must have the Superuser or Courses administrator role or the academic-terms permission.

Share tables

Mon, 01 Jan 0001 00:00:00 +0000

You can create tables for personal use or share them with others for teamwork, reviews or collaborative analysis.

Depending on who requires access, you can share tables in the following ways:

Private use: A table is only visible to an Administrator who created it.
Shared with Administrators: A table is shared with all Administrators or specific Administrators.
Shared via a share link: A table is shared via a share link generated in DreamApply and sent to a recipient. The recipient can open the table and view it without creating an account in the system.

Before you begin

To share tables, your account must have the Superuser, Admissions administrator or Academic supervisor role or the applications-view permission.

Subscribe to updates

Mon, 01 Jan 0001 00:00:00 +0000

To set up a webhook, you must create a journal, subscribe to the desired events and configure a webhook for that journal.

Before you begin

To set up webhooks, your account must have the Superuser role or the journal-edit, journal-view and api permissions.

Set up a webhook

To set up a webhook in DreamApply:

In the main menu, under Applications, select Journal.
At the bottom of the journal list, click New journal.

Track search terms with GTM

Mon, 01 Jan 0001 00:00:00 +0000

The Find programmes page in DreamApply includes a search box that allows applicants to search for programmes. You can track what users search for and analyze these terms in Google Analytics.

To do this, we will integrate DreamApply with Google Tag Manager, set up a tag to capture search terms from search interactions and send them to Google Analytics for reporting.

Before you begin

Make sure your Administrator account in DreamApply has the Superuser role.
Make sure you have an account and container in Google Tag Manager. For details, see Create an account and container in the Google documentation.
Make sure you have an account and a data stream in Google Analytics. For details, see Add a data stream in the Google documentation.

Step 1. Integrate with Google Tag Manager

First, we need to connect DreamApply to Google Tag Manager.

Unassign and delete trackers

Mon, 01 Jan 0001 00:00:00 +0000

In some cases, you may want to unassign and delete trackers that were previously assigned to leads.

Before you begin

To unassign trackers, your account must have the Superuser or Admissions administrator role or the applicants-view and applicants-edit permissions.
To delete trackers, your account must have the Superuser, Admissions administrator or Marketing administrator role or the trackers permission.
To subscribe to journal events, your account must have the Superuser or Admissions administrator role or the journal-view and journal-edit permissions.

Unassign trackers

You may want to remove a tracker assigned to a lead, for example, if a lead is no longer associated with a specific campaign.

Use tracking templates

Mon, 01 Jan 0001 00:00:00 +0000

If your institution uses Google Ads to promote campaigns, you can set up tracking templates in DreamApply. Tracking templates allow you to measure how effective your ads are, even if these ads direct users to external websites.

How tracking templates work

A tracking template is a URL structure used in advertising platforms to monitor how users interact with ads. Tracking templates are set up in DreamApply and have the following format:

VAT rates

Mon, 01 Jan 0001 00:00:00 +0000

To identify the current VAT rates, DreamApply relies on a community-maintained collection of VAT rates for European Union member states maintained as a JSON file.

DreamApply uses the applicable standard rate based on the most recent effective_from date, for example:

VAT rates

 JSON
 
 
{
 "details": "https://github.com/ibericode/vat-rates",
 "version": 4,
 "items": {
 "...",
 "CZ": [
 {
 "effective_from": "2024-01-01",
 "rates": {
 "reduced": 12,
 "standard": 21
 }
 },
 {
 "effective_from": "0000-01-01",
 "rates": {
 "reduced1": 10,
 "reduced2": 15,
 "standard": 21
 }
 }
 ],
 "...",
 }
}

What's new in DreamApply

Mon, 01 Jan 0001 00:00:00 +0000

Stay up-to-date with the latest features and updates in DreamApply.

May 2026

Application closing

Mon, 01 Jan 0001 00:00:00 +0000

Represents a resource that allows closing an application

URI

/api/v9/applications/ID/close

Close an application

Close an application.

Closing an application formally finalizes the application status. It indicates that no further actions will be taken on the application, regardless of the admission decision.

To record the action, DreamApply creates the Application was closed journal event.

Syntax

POST /api/v9/applications/123/close
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X POST \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/close"

Response codes

Response code	Description
`201 Created`	The application was successfully closed
`400 Bad Request`	This application cannot be closed, for example, if a request is sent to an already closed application
`404 Not Found`	The application was not found

Application filing

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, institutions can link programmes to one or more intakes. On the programme description page and programme tiles in the catalog, DreamApply displays a set of Apply now! buttons — one for each linked intake. Instead of showing intake names, the buttons are labeled with the target academic terms, for example, Fall semester 25/26. This helps applicants immediately understand when their studies would begin.

Depending on the intake settings, some buttons can be active, while others can be disabled or hidden to show that the intake has not yet started.

Application statuses

Mon, 01 Jan 0001 00:00:00 +0000

Represents a list of all application statuses.

URI

/api/v9/applications/statuses

List application statuses

List all application statuses configured for this setup.

Note that in the GUI the statuses will be displayed according to their title property (see the Browse menu). However, when filtering applications by statuses (see GET /api/v9/applications), you must use the actual status names, not their title property. In many cases, they overlap, but this cannot be guaranteed to be so.

Assign grants and scholarships

Mon, 01 Jan 0001 00:00:00 +0000

When you assign financial aid in DreamApply, you mark a candidate as eligible for a specific grant or scholarship. While DreamApply does not process actual payments or disbursements, it can help model different scenarios, identify the most qualified candidates and visualize how funds could be distributed.

You can identify candidates and assign grants and scholarships in two ways:

Manually: This type of assignment provides full control and allows you to select candidates individually.
Automatically through bulk assign: You can use the Bulk award wizard to streamline the allocation process.

Before you begin

To manually assign grants and scholarships, your account must have the Superuser role or the grants, offers-view and offers-edit permissions.
To assign grants and scholarships in bulk, your account must have the Superuser role or the grants permission.
To subscribe to journal events, your account must have the Superuser or Admissions administrator role or the journal-view and journal-edit permissions.

Manually assign grants and scholarships

To manually assign a grant or scholarship:

Calculate compensation

Mon, 01 Jan 0001 00:00:00 +0000

Assume your institution works with Advisors to help recruit applicants. You want to track which applicants they have brought and calculate their compensation based on results — such as how many applicants were enrolled.

To do this, we will set up an Advisor account with a dedicated tracker, register new users through the Advisor and generate reports showing their performance.

Before you begin

Make sure your account has the Superuser role. In a real case, roles can be configured differently.

Comments

Mon, 01 Jan 0001 00:00:00 +0000

Represents the comments for the scoresheet score.

URI

/api/v9/scoresheets/ID/scores/ID/comments

Get comments

A request with the GET verb returns the score’s comments as JSON encoded string (or null, if there are no comments stored).

Syntax

GET /api/v9/scoresheets/123/score/321/comments
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/scoresheets/123/scores/321/comments"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The comments were successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"Some comments"

Add comments

Set the comments of a scoresheet score to a particular text.

Confirm the right to be forgotten

Mon, 01 Jan 0001 00:00:00 +0000

When an applicant requests deletion of their account or DreamID, DreamApply does not immediately delete the applicant account. Instead, it creates a data deletion request that an Administrator must review and confirm.

Data deletion requests are displayed in the Data protection > Right to be forgotten section. Once an Administrator confirms the request, DreamApply schedules the permanent deletion. The account, along with all associated data and resources, is permanently removed within 24 hours during an overnight cleanup process.

Create Advisor accounts

Mon, 01 Jan 0001 00:00:00 +0000

You must set up accounts for all Advisors involved in the admission process. To do this:

Add an Advisor account
Define the Advisor account contacts

Before you begin

To set up an Advisor account, your account must have the Superuser or Marketing administrator role or the advisors permission.

Add an Advisor account

To add an Advisor account:

In the main menu, under Marketing, select Advisors.
Under the Advisor list, click New advisor.
Specify the Advisor’s name and the territory from which they send applicants.
If necessary, in the Tracker field, change the name of the tracker that will be assigned to applicants managed by this Advisor.
In the Postal address section, provide the Advisor’s address if necessary.
In the Policy section, select the permission level for the Advisor and enable required options. For details, see Advisor permission levels.
In the Contract validity section, define the account active period. To limit the account lifetime, you can specify a start date, an end date or both.
If necessary, add the Advisor account to a specific group, provide additional notes and upload accompanying documentation.
At the top of the form, click Save changes and define the Advisor account contacts if necessary.

The Email address(es) field is outdated and must not be used. Use the Contacts section to define the Advisor contacts.

Define the Advisor account contacts

After you create an Advisor account, you can define one or more contacts for it. The Advisor account contacts serve two purposes:

Create and assign additional appforms

Mon, 01 Jan 0001 00:00:00 +0000

To collect extra information in specific cases, you can create additional appforms and assign them to applications. DreamApply will merge sections of additional appforms with sections of the programme-specific appform and display a combined, unified structure to applicants.

Before you begin

To manage appforms, your account must have the Superuser or Courses administrator role or the appforms permission.
To edit programme settings, your account must have the Superuser or Courses administrator role or the courses-view and courses-edit permissions.
To set up automatic rules, your account must have the Superuser role or the rules permissions.
To edit offer type settings, your account must have the Superuser role or the offer-view and offer-edit permissions.

Create additional appforms

In DreamApply, additional appforms are configured in the same way as programme-specific appforms but are not linked to programmes. For details, see Create programme-specific appforms.

Define territory requirements

Mon, 01 Jan 0001 00:00:00 +0000

In some cases, institutions may need to restrict access to specific programmes based on the applicant’s citizenship. These restrictions help institutions stay compliant with security policies, sanctions and funding conditions.

DreamApply offers two ways to manage territory requirements:

At the programme level
In bulk

Territory requirements are displayed on the programme page, in the Territory requirements section, and are applied based on the citizenship applicants select during application. If an applicant selects a citizenship associated with a denied territory, the following restrictions apply:

DreamApply PHP SDK

Mon, 01 Jan 0001 00:00:00 +0000

Email types

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply handles various types of emails such as:

Authentication-related emails
Messages sent to applicants
Messages sent to other parties such as Administrators, advisors

These types of emails are sent in different ways, each tailored to its specific purpose.

Authentication-related emails are sent by DreamID, the DreamApply service that provides a secure authentication layer for applicants and Administrators.

DreamID sends the following types of emails:

Confirmation emails: Sent to verify or change the email address associated with the DreamApply account
Confirmation emails for account deletion: Sent to confirm the user’s intent to delete their DreamApply account
One-time verification link: Used to verify the email address ownership

Authentication-related emails are sent on behalf of the institution in the text and HTML format with the following parameters:

Enter scores

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply offers several ways to collect and record scores depending on the scoresheet type and the required level of expertise:

Applicant self-scoring: For public and unlisted scoresheets, applicants can enter their own scores by using the Scores section on the application edit page. DreamApply automatically saves this data and makes it available to evaluators for subsequent review.
Expert evaluation: For scoresheets that require professional judgment, institutions can manage the scoring process in the following ways:

Export tables

Mon, 01 Jan 0001 00:00:00 +0000

You can export tables for offline analysis, reporting or archiving. DreamApply supports two export formats — Excel and CSV.

When exporting data, you can choose how to display application IDs:

Plain text: Display application IDs as non-clickable text.
Clickable links: Display application IDs as URLs that link directly to application pages in DreamApply. Anyone who has access to the exported file can click these URLs to view applications in the system, even if they do not have an account in DreamApply.

Before you begin

To export tables, your account must have the Superuser, Admissions administrator or Academic supervisor role or the applications-view permission.

How to set up Matomo tags

Mon, 01 Jan 0001 00:00:00 +0000

Follow this example to learn how to use Matomo Tag Manager with DreamApply to implement tracking scenarios.

Example

To do this, we will integrate DreamApply with Matomo Tag Manager, set up a tag to capture this data and send it to Matomo Analytics for reporting.

Integrate with HubSpot

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply utilizes the HubSpot private apps to integrate with HubSpot. Private apps provide a secure way to connect to your HubSpot account using access tokens generated in the HubSpot portal.

During the export process, DreamApply sends the following data:

Email address
Full name
Location/citizenship
Phone number (if entered correctly with the country code)
Language preference (if available)
Registration date
DreamApply applicant ID
DreamApply applicant reference code
DreamApply applicant matriculation number

The exported data is registered as contact records in HubSpot and linked to a specific contact owner. To store DreamApply-specific information, such as applicant ID, citizenship and registration date, DreamApply creates custom properties in the contact record and displays them under the DreamApply information properties group.

Integrate with SmartHub

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply integrates with SmartHub by Keystone Education Group, allowing you to import lead data from the platform.

During the import process, DreamApply pulls the following data:

First name
Last name
Email address
Phone number and other available fields

You can map each lead field to the corresponding fields in the applicant records in DreamApply.

To import lead data to DreamApply, perform the following tasks:

Obtain an API key
Configure integration settings

Before you begin

To integrate with DreamApply, your account must have the Superuser role or the integrations permission.

Make offers in bulk

Mon, 01 Jan 0001 00:00:00 +0000

To make offers to multiple applicants at once, you can run the Send bulk offers tool in the Rankings view. This tool allows you to process both manually selected offers or offers selected automatically by DreamApply based on existing offer quotas.

Upon processing offers, you can:

Save the results to review and finalize them later
Immediately send out offers to selected applicants

Before you begin

To run the Send bulk offers tool, your account must have the Superuser or Admissions administrator role or the offers-confirm permission.
To use auto-selection, you must configure at least one offer quota for the academic year.

Select and process offers

To select and process offers for multiple applicants:

Manage meeting registrations

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply offers two options for registering to meetings:

Simple registration
Scheduled slots

Administrators can view and manage participant registrations: change the time slot or remove participants from the meeting. This capability can be helpful for managing high-demand meetings and events.

Before you begin

To view and manage meeting registrations, your account must have the Superuser role or the meetings-view, meetings-registrations-view and meetings-registrations-edit permissions.

Edit meeting registrations

To edit registrations for a meeting:

Migrate Advisor accounts

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply is transitioning Advisor accounts from legacy access codes to a new authentication model. Each Advisor now requires a DreamID to log in. This update improves security and accountability, and provides a consistent login experience for both Administrators and Advisors.

Steps to complete migration

When your institution is ready to migrate, complete the following steps:

Notify DreamApply: Inform the DreamApply team that you are ready to migrate. We will enable the new login mechanism for your instance.
Update contact info: Add one or more contact records to the Advisor account and click Send out access invitation for those contacts that must have access to the DreamApply portal. For details, see Define the Advisor account contacts.
Automated invitations: For every invited contact, DreamApply will generate a DreamID and send a welcome email with joining instructions to the specified email address.
First login: Advisors will log in via the Advisor login section using their DreamID. During the first login, they must confirm their email address to finalize their account setup.

Migration notes

The migration affects only the login mechanism. Advisor access policies, the portal interface and available features remain unchanged.
You may continue using the legacy login method until you are ready to switch. However, we recommend migrating as soon as possible to ensure improved security.

Offer comments

Mon, 01 Jan 0001 00:00:00 +0000

Represents the offer letter text/comments for the application offer.

URI

/api/v9/applications/ID/offers/ID/comments

Get the offer comments

A request with the GET verb returns the offer letter text (“comments”) for this particular offer (identified by offer ID).

Syntax

GET /api/v9/applications/123/offers/321/comments
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/offers/321/comments"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The offer letter text (“comments”) was successfully returned
`404 Not Found`	The application does not have this offer

Example response

Response

"Hello\n\nCongratulations, you are now accepted to ...."

Set the offer comments

Set the offer letter text (“comments”) to the application offer (identified by its ID).

Perform access audit

Mon, 01 Jan 0001 00:00:00 +0000

To keep your DreamApply instance secure, it is important to regularly perform user access reviews. DreamApply offers several tools that can help you identify potential issues and prevent unauthorized access:

Audit Administrator permissions
Review Administrator logins

Before you begin

To perform access audit, your account must have the Superuser role or the data-protection permission.

Audit Administrator permissions

The Audit Administrator permissions tool allows you to quickly review all assigned permissions in a single, easy-to-read table. Use it to quickly identify any discrepancies and irregularities and adjust access levels as needed.

Process payments

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply lists all issued invoices in the Invoices view under Finance. You can use this view to track the status of each invoice, monitor payments and keep financial records organized.

Before you begin

To view and manage invoices, your account must have the Superuser or Accountant role or the accounting-view and accounting-edit permissions.
To subscribe to journal events, your account must have the Superuser or Admissions administrator role or the journal-view and journal-edit permissions.

Track invoices

Using the Invoices view, you can check invoices statuses and see whether they are fully paid, partially paid or still pending.

Resend events

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply allows you to resend events to the webhook endpoint. Resending events can be useful in the following scenarios:

Some events were not delivered due to temporary failures
The webhook endpoint was unavailable
The webhook was paused and needs to catch up

You have the following options to resend events:

Rewind webhook events (for active webhooks)
Resume event sending (for paused webhooks)

Before you begin

To manage webhooks, your account must have the Superuser role or the journal-edit, journal-view and api permissions.

Resource access policies

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, Administrators can have full access to system resources or have their access restricted to specific ones. This type of access control is managed through resource access policies.

A resource access policy determines which system resources an Administrator can access and manage. Policies complement role- and permission-based access control. As a result, Administrators can efficiently perform their tasks without access to unrelated system resources.

Types of resources

DreamApply allows configuring access policies for the following types of resources:

Run AI analysis

Mon, 01 Jan 0001 00:00:00 +0000

To analyze application data, you can run prepared AI prompts for selected applications.

AI Highlighter analyzes application data on the per-application basis. You can run a prompt in the following ways:

For individual applications
For a group of applications
Using rules

Before you begin

To analyze applications with AI, your account must have the Superuser or Admissions administrator role or the ai-inrefence, applications-view, applications-edit permissions.
To set up automatic rules, your account must have the Superuser role or the rules permissions.

Analyze individual applications

To analyze a single application:

Select the programme discovery mode

Mon, 01 Jan 0001 00:00:00 +0000

You can select the programme discovery mode for the DreamApply portal. The discovery mode defines:

How the programme catalog is presented to applicants
What navigation options are available
How applicants begin their admission journey

DreamApply offers the following programme discovery modes:

Search: This mode is intended for institutions with a broad programme catalog. It provides quick access to programmes through a search bar, filters and the Find programmes option in the portal menu.
Browse: This mode is intended for institutions with a small number of programmes and a structured catalog divided by programme types. This layout removes the search bar and filters from the front page. Applicants can navigate using the call-to-action button, option in the portal menu or use the Browse Programmes list on the front page.
Lite: This mode is intended for institutions with a small number of programmes who prefer a minimalistic layout. It provides a clean, focused view without a search bar or menu options.
Auto: In this mode, DreamApply automatically selects the most suitable layout based on the structure and volume of the institution’s programme catalog.

Discovery mode comparison

The table below describes which UI elements are available in each discovery mode.

Set conversion rules

Mon, 01 Jan 0001 00:00:00 +0000

To standardize scores from different grading systems into a uniform format, you can use conversions in DreamApply. Conversions ensure consistency in evaluation, regardless of the grading scale used.

DreamApply offers several conversion options:

Predefined rules for common academic and language tests like the ACT, GMAT, TOEFL and IELTS
Custom formulas
Custom lookup tables

Before you begin

To set up custom conversion formulas or lookup tables, your account must have the Superuser role or the scorers permission.

Set up an institution profile

Mon, 01 Jan 0001 00:00:00 +0000

To showcase your institution effectively, you can set up its profile. The profile information, along with general institution details, is displayed on the About us page in the DreamApply portal, giving prospective applicants a clear and engaging view of your institution.

Before you begin

To update an institution profile, your account must have the Superuser role or the institutions permission.

Edit a profile

To set up an institution profile:

Set up intakes

Mon, 01 Jan 0001 00:00:00 +0000

To define admission paths for applicants, you need to set up intakes in DreamApply. An intake defines the timeline, structure and key stages of the application process.

DreamApply lets you set up multiple intakes to accommodate different applicant categories. As a result, each category can have its clear and custom application track to follow.

You do not need to clone or create new intakes each year. Configure them to be reusable and give them neutral names that do not reference a specific year. This reduces annual setup work, as you only need to update the intake deadlines when a new cycle begins.

Set up offer quotas

Mon, 01 Jan 0001 00:00:00 +0000

To limit the number of offers made to applicants, you can set up offer quotas.

An offer quota defines the maximum number of available places based on certain conditions. When an applicant meets the quota criteria, DreamApply automatically reserves a place within that quota. These reservations are recorded internally for Administrators and are not visible to applicants.

Each quota is linked to a specific academic term and offer type. DreamApply consistently enforces quotas, no matter how offers are made — manually by Administrators or through the auto-selection tool.

Set up official use sections

Mon, 01 Jan 0001 00:00:00 +0000

To record internal information needed for admission processing, you can add official use sections to appforms. These sections can be helpful for administrative details such as:

Internal Administrator records
Housing or accommodations assignments
Scholarship or funding decisions
Special admission routes or exceptions

Only Administrators can complete and view official use sections. These sections are hidden from applicants and Advisors to guarantee that sensitive information remains secure.

Before you begin

To set up official use sections in appforms, your account must have the Superuser or Courses administrator role or the appforms permission.
To complete official use sections, your account must have the Superuser or Admissions administrator role or the applications-view and applications-edit permissions.

Add official use sections

To add an official use section to an appform:

Statistics

Mon, 01 Jan 0001 00:00:00 +0000

To gain insights into the admission process using structured data, you can use the Statistics view in DreamApply. This view allows you to explore statistics using predefined data segments, apply filters and compare data across different segments.

To access application statistics, in the main menu, under Applications, select Statistics.

Before you begin

To view application statistics, your account must have the Superuser, Admissions administrator, Academic supervisor, Academic consultant, Marketing administrator or Accountant role or the applications-view permission.

Testing

Mon, 01 Jan 0001 00:00:00 +0000

Although the DreamApply API uses standard HTTP requests, you cannot test and debug them from a browser address bar. All requests must include the Authentication header.

To test and debug API requests, use a REST client that supports requests headers, for example, command-line tools like cURL or IDE extensions that send HTTP requests.

Track application events

Mon, 01 Jan 0001 00:00:00 +0000

Assume you want to track the number of created, submitted and withdrawn applications in Google Analytics. You want to leverage the information about events pushed to the data layer by DreamApply.

To do this, we will integrate DreamApply with Google Tag Manager, set up a tag to capture these events and present them as a report in Google Analytics.

Before you begin

Make sure your Administrator account in DreamApply has the Superuser role.
Make sure you have an account and container in Google Tag Manager. For details, see Create an account and container in the Google documentation.
Make sure you have an account and a data stream in Google Analytics. For details, see Add a data stream in the Google documentation.

Step 1. Integrate with Google Tag Manager

First, we need to connect DreamApply to Google Tag Manager.

Track referrer domains

Mon, 01 Jan 0001 00:00:00 +0000

To understand where users come from when they arrive at DreamApply, you can set up referrer domain tracking.

This method is useful when applicants arrive at DreamApply from other websites such as your main institutional website, specific faculty pages or partner portals. By tracking referrer domains, you can see which websites send users to DreamApply and measure which ones drive the most engagement and conversion.

How referrer domains work

To use referrer domain tracking, you must set up your websites to send the Referer HTTP header and create an entry point for the website domain in DreamApply.

View task progress

Mon, 01 Jan 0001 00:00:00 +0000

You can monitor the task progress using the following tools:

Tasks view
Journal

Before you begin

To use the Tasks view, your account must have the Superuser, Admissions administrator, Academic supervisor, Academic consultant or Marketing administrator role or the applications-view permission.
To subscribe to journal events, your account must have the Superuser or Admissions administrator role or the journal-view and journal-edit permissions.

Use the Tasks view

To monitor the progress of tasks assigned to applicants, use the Applications > Tasks view. This view provides a high-level summary of task completion across all applicants in both a graph and a table.

Watch interviews

Mon, 01 Jan 0001 00:00:00 +0000

All interview sessions recorded and submitted by applicants are securely stored in the DreamApply system. You can access these recordings at any time for review.

Before you begin

To watch and manage interviews, your account must have the Superuser or Admissions administrator role or the interviews permission.
To subscribe to journal events, your account must have the Superuser or Admissions administrator role or the journal-view and journal-edit permissions.

Review and manage recordings

To review submitted recordings:

API quota limits

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply limits the number of API requests that you can make over a specific period of time. These limits help prevent API abuse and maintain stable usage for all DreamApply clients.

Request quotas

By default, all API requests using the same API key are limited to 180 requests per minute.

A limit of 180 requests per minute does not mean that requests must be spaced evenly, for example, three requests per second. DreamApply calculates the total number of requests within the time window. A rapid succession of requests is allowed, but it can exhaust your quota more quickly.

Application freezing

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, Administrators can freeze application data at key stages of the admission process. Application freezing locks previously entered details but still allows applicants to add new or missing information. This helps institutions maintain clear, consistent records and reduces the risk of errors during the review process.

How application freezing works

When applications are frozen, applicants can no longer edit the information they have already submitted. DreamApply locks the existing data on the application edit page and informs applicants that editing is limited.

Customize meeting notifications

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply automatically sends notifications with meeting details when participants register for simple registration or scheduled slot meetings or unregister from them. These notifications are accessible in the Messages view of the Applicant portal and delivered as emails to participants.

You can customize these messages through templates to tailor the content to your tone and specific requirements. Message templates can include personalized details such as the participant’s name and event-specific details, ensuring clear and professional communication.

Date

Mon, 01 Jan 0001 00:00:00 +0000

Represents the date of the scoresheet score.

URI

/api/v9/scoresheets/ID/score/ID/date

Get the date

A request with the GET verb returns the score’s date as a JSON encoded string (or null, if there is no date stored).

Syntax

GET /api/v9/scoresheets/123/score/321/date
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/scoresheets/123/scores/321/date"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The date was successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"2025-01-30"

Set the date

Set the date of a scoresheet score to a particular value.

Define application form settings

Mon, 01 Jan 0001 00:00:00 +0000

To collect programme-specific information from applicants, you can configure application form settings at the programme level. This may be useful when a programme requires information not covered by programme-specific or additional appforms.

When these settings are enabled, DreamApply modifies the application edit page to include additional fields or sections based on the programme requirements, such as references, motivation letters and portfolios.

Each programme in the catalog can have its own configuration. As a result, the application edit page may vary depending on the selected programmes, and applicants will need to submit information specific to the requirements of these programmes.

Define evaluation criteria

Mon, 01 Jan 0001 00:00:00 +0000

You can define evaluation criteria that determine how scores from various inputs are weighted and final scores are calculated.

Using criteria is the recommended method for managing scoresheet assignments and calculating final results. By using criteria, you can:

Define a clear evaluation model: Outline how different scores contribute to the final result.
Implement a programme-specific approach: Link criteria to programmes to align with their unique requirements.
Avoid incomplete evaluations: DreamApply automatically adds applications to the relevant scoresheets required by the criteria. This ensures all necessary scores are included in the final calculation.

Before you begin

To define criteria, your account must have the Superuser role or the scorers permission.

Delete tasks

Mon, 01 Jan 0001 00:00:00 +0000

In some cases, applicants may receive irrelevant tasks. This can happen, for example, if an applicant removes a programme that required a task or if programme requirements change after a task is assigned. In these cases, you can:

Send tasks to trash
Delete tasks

Before you begin

To send tasks to trash and delete tasks, your account must have the Superuser or Admissions administrator role or the applications-view and tasks permissions.

Duplicate emails detection

Mon, 01 Jan 0001 00:00:00 +0000

To maintain the efficiency of email communication, DreamApply provides duplicate email detection. This feature helps prevent accidental duplicate emails, which can occur by mistake or when using the Send email to all option.

DreamApply automatically checks for duplicate emails by comparing key parameters like subject, recipients, body and attachments. If an identical email is detected in less than 24 hours, it is automatically blocked to avoid redundancy. Duplicate emails are marked as failed and will not be delivered to the recipient.

Group applications

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, each application is filed under a specific academic term. You can choose to group applications by additional criteria such as institution, department or programme.

Before you begin

To configure application settings, your account must have the Superuser role or the instance permission.

Define grouping settings

To group applications:

In the main menu, under System, select Settings.
In the left menu, select Application settings.
Under Application grouping, choose how applications must be grouped.

How to score applicants

Mon, 01 Jan 0001 00:00:00 +0000

This example demonstrates how you can use the scoring tools in DreamApply to create a custom scoring model.

Assume we want to score applicants to a university’s computing programme. The evaluation must be based on the following key parameters:

Prior academic results: The applicant’s high school computer science grades
Problem solving: A Skype interview assessing logical thinking
English proficiency: Measured by TOEFL or IELTS test scores

These parameters will be integrated into a single evaluation criterion to ensure fair and consistent assessment of each applicant’s qualifications.

Integrate with Mailchimp

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate DreamApply with Mailchimp to export applicant data. DreamApply sends the following data:

Email address
Full name
Location/citizenship
Trackers as Mailchimp tags

The exported data is registered as contact records in Mailchimp and placed into the selected audience.

To export applicant data, perform the following tasks:

Verify the Mailchimp audience settings
Obtain an API key
Configure integration settings

Before you begin

To integrate with DreamApply, your account must have the Superuser role or the integrations permission.

Lists

Mon, 01 Jan 0001 00:00:00 +0000

You can use the following types of lists:

Unordered lists
Ordered lists
Mixed lists
Definition lists

Unordered lists

To create an unordered (bulleted) list, start each list item with an asterisk *. To create a nested list, add an extra asterisk * at the beginning of the line.

Unordered list formatting

 Textile
 
 
* First item
** Subitem 1
** Subitem 2
* Second item
* Third item
* Fourth item

Unordered list formatting

 HTML
 
 
<ul>
 <li>First item
 <ul>
 <li>Subitem 1</li>
 <li>Subitem 2</li>
 </ul>
 </li>
 <li>Second item</li>
 <li>Third item</li>
 <li>Fourth item</li>
</ul>

Ordered lists

To create an ordered (numbered) list, start each list item with a hash #. To create a nested list, add an extra hash # at the beginning of the line.

Make offers

Mon, 01 Jan 0001 00:00:00 +0000

To move offers forward in the application process and communicate progress to applicants, you can set offer types for each offer in the application.

DreamApply offers two options for setting offer types:

Manually: You can set offer types, save and send out individual offers using offer cards.
In bulk: You can use DreamApply filtering and automation tools to identify top candidates and send out offers in bulk.

DreamApply may not display offer buttons for some priorities on the application card. This can happen if the priority has not yet been submitted. For details, see Offer workflows.

Manage allocations

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply displays information about allocated grants and scholarships in several places in the system:

Ranking list
Offers for an applicant
Allocations report

Before you begin

To view the ranking list and work with offers, your account must have the Superuser, Admissions administrator or Academic supervisor role or the offers-scoring permission.
To view and assign grants and scholarships, your account must have the Superuser role or the grants, offers-view and offers-edit permissions.

View the ranking list

To view awarded applicants in the ranking list, in the main menu, under Applications, select Rankings. DreamApply marks such applicants with the heart icon and specifies the type of financial aid they have received.

Manage flags

Mon, 01 Jan 0001 00:00:00 +0000

In addition to standard application statuses and offer types, Administrators can use flags to categorize applications. Flags allow Administrators to mark and identify applications based on specific criteria, making it simpler to process them.

In DreamApply, flags are created and managed at the institution level. Administrators can view, assign and manage flags created by other Administrators, which allows for consistency and collaboration.

Before you begin

To manage access to flags, your account must have the Superuser role or the administrators permission.
To manage flags, your account must have the Superuser role or the flags permission.
To assign existing flags, your account must have the Superuser, Admissions administrator or Academic supervisor role or the applications-flag permission.
To subscribe to journal events, your account must have the Superuser or Admissions administrator role or the journal-view and journal-edit permissions.

Assign roles and permissions

To let Administrators work with flags, you must assign roles and permissions to them and grant them access to specific flags.

Mark invoices as lapsed

Mon, 01 Jan 0001 00:00:00 +0000

In some cases, an issued invoice is no longer needed and should be removed from the active admission process. This typically occurs when:

An application is moved to a later term.
An applicant withdraws their application.
An invoice needs to be corrected and reissued.

To manage invoices that should no longer be considered for payment, you can mark invoices as lapsed. When an invoice is marked as lapsed:

DreamApply excludes the invoice from processing and payment tracking. The system can automatically generate a new invoice for the application if a fee trigger event occurs, for example, a new course is added to the application or the application is re-submitted.

Promote tables

Mon, 01 Jan 0001 00:00:00 +0000

To promote high-priority tables, you can star them in DreamApply. When a table is starred, it appears first in the tables view for all Administrators who have access to the table. You can also use the Starred filter to quickly locate these tables.

Before you begin

To promote tables, your account must have the Superuser, Admissions administrator or Academic supervisor role or the applications-view permission.

Star tables

To star a table:

Recover data

Mon, 01 Jan 0001 00:00:00 +0000

When an Administrator confirms a request to delete an account or purge application data, DreamApply flags that data for deletion. The flagged data is permanently deleted within 24 hours during an overnight cleanup process.

Before the cleanup process begins, Administrators can recover flagged data. Restoring the data immediately reactivates all associated resources and information and makes it available in the system as if no deletion request has been submitted.

Before you begin

To recover applicant data, your account must have the Superuser role or the data-protection permission.

Select the institution discovery mode

Mon, 01 Jan 0001 00:00:00 +0000

If your institution uses the multi-institution setup, DreamApply automatically displays a list of institutions on the front page, right below the main banner. This list allows applicants to easily browse institutions within your organization.

To customize how this list appears, you can select the institution discovery mode. DreamApply offers the following modes:

Alphabetic list: Institutions appear in alphabetical order.
Randomized list: Institutions appear in a random order each time the page is loaded.
Randomized list: Institution logos appear in a random order as a grid each time the page is loaded. Additionally, DreamApply displays the Show all institutions button that takes applicants to the Institutions page.
Lite: DreamApply displays the Show all institutions button that takes applicants to the Institutions page.
Auto: In this mode, DreamApply automatically selects the most suitable layout based on the number of institutions in your organization.

Before you begin

To adjust institution discovery, your account must have the Superuser role or the instance permission.

Share-based access

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, Administrators can use links shares to give external parties access to resources without requiring them to create an account. Link sharing can be useful in scenarios when it is necessary to share or distribute resources for a limited time. For example, an Administrator may share an application with a reviewer involved in applicant evaluation.

Links shares can be used for the following resources:

Applications
Scoresheets
Tables
Invoices (legacy sharing is used)

Administrators can share resources via an email address or by copying a shareable link to send to a recipient. Each share is assigned an expiry date.

View AI processing statistics

Mon, 01 Jan 0001 00:00:00 +0000

AI Highlighter logs all AI responses and processing activities. You can:

Track AI processing statistics
Review AI outputs
Detect errors that occurred during AI data processing

To view the AI statistics, in the main menu, under AI highlighter, select Highlights.

AI Highlighter automatically detects and logs several types of errors that may occur during AI data processing:

Missing data: The LLM was unable to generate a response due to insufficient information in the provided context materials
Prompt injection: A request was blocked because the prompt attempted to override the initial instructions (a security measure, may occur if a third-party attacker tried to inject malicious instructions into the prompt)
Confusing prompt: The instructions provided in the prompt were contradictory or unclear
Defer to human: The prompt task violated ethical policies or core AI directives; the response requires human review
Other reasons: A generic processing error occurred

To view a list of errors, use the AI highlighter > Statuses category in filters.

View entry point statistics

Mon, 01 Jan 0001 00:00:00 +0000

When users click entry point URLs placed in campaign materials, DreamApply automatically captures and records the following data:

Click event
Referral information (if sent)
UTM parameters (if sent)
User-related details such as country, browser and platform
Entry point ID

You can view this data through dedicated reporting sections in DreamApply:

Entry points: Provides statistics on clicks and insights into entry points, including top user platforms, referrer domains, browsers and countries.

View purge logs

Mon, 01 Jan 0001 00:00:00 +0000

To support system audits and internal accountability, DreamApply provides data purge logs. Purge logs allow you to monitor who initiated a data removal action and track details of each deletion, including:

Purged resource
ID and creation date
Deletion request and actual data deletion dates

Before you begin

To view purge logs, your account must have the Superuser role or the data-protection permission.

Access logs

To view purge logs, under Data protection, select Data purge logs.

Application withdrawal

Mon, 01 Jan 0001 00:00:00 +0000

Applicants can withdraw applications at any time. This may be needed if an applicant decides to stop the admission process or submitted an application by mistake.

How application withdrawal works

To withdraw an application, applicants can use the Withdraw application option in the application card. An application can be withdrawn unless it has one of the following statuses:

Closed

Expired

When an application is withdrawn, DreamApply changes its status to Withdrawn. All withdrawn applications are displayed in the Browse view, under Application progress > Withdrawn.

Best practices

Mon, 01 Jan 0001 00:00:00 +0000

To use the DreamApply API efficiently, follow the recommendations below. These techniques help optimize performance, reduce network traffic and make integrations with DreamApply more reliable.

Use filter parameters efficiently

Use filtering parameters to limit the amount of returned data. By applying filters, you can retrieve only the records relevant to your use case.

Filter indicators: Parameters starting with by indicate a filter. For example, byStatuses=Online filters for the Online status.
Logical OR: Lists in filtering parameters are combined with a logical OR operator. Lists can be comma-separated or space-separated. For example, GET /api/courses?byStatuses=Online,Standby returns courses where the status is either Online or Standby.
Logical AND: Different filtering parameters are combined with a logical AND operator. For example, GET /api/courses?byStatuses=Online&byTypes=UG returns courses where the status is Online and the type is Undergraduate.

Use the expand parameter

For some collections and resources, the DreamApply API offers the expand parameter. Use it to retrieve related entities in a single request instead of making multiple follow-up requests. expand is especially useful when you need associated data, such as applicant’s trackers, documents or invoices, together with the primary resource.

Collect applicant consents

Mon, 01 Jan 0001 00:00:00 +0000

To meet regulatory, legal and institutional requirements, institutions can define and manage applicant consents in DreamApply. Applicant consents are used to fulfil obligations related to the processing of personal data, including:

General Data Protection Regulation (GDPR)
ePrivacy regulations
National legislation
Internal institutional rules

Applicant consents are displayed as check boxes on the registration page. They guarantee that applicants are clearly informed how their data is used and have the opportunity to accept or reject specific terms and conditions.

Consent

Mon, 01 Jan 0001 00:00:00 +0000

Represents a specific consent associated with an applicant. For a specific consent available in the system, see Consent (global).

URI

/api/v9/applicants/ID/consents/ID

Get an associated consent

Get a consent associated with an applicant.

This request does not return the consent itself, but rather represents the relationships between the applicant and the consent. Follow the consent URI in the response to retrieve further information about the consent in question.

Define the SEO settings

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply allows you to control how search engines discover and index your portal content and how automated agents interact with it.

You can configure the following search engine settings:

Sitemap configuration
robots.txt configuration

Before you begin

To define SEO settings, your account must have the Superuser role or the instance permission.

Configure sitemap settings

A sitemap helps search engines understand which programmes you offer and improves their discoverability.

Import leads

Mon, 01 Jan 0001 00:00:00 +0000

You can import leads in bulk from files or external platforms. This method can be useful for leads collected through offline campaigns, partner programmes or other external marketing efforts.

Imported leads are registered as natural persons. Each lead receives a welcome email from DreamApply with a registration link they can use to set up their account and continue the application process.

During the import process, you can assign a specific tracker to imported leads. This way, you can indicate and trace the original source of applicants.

Integrate with MailerLite Classic

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate DreamApply with MailerLite Classic to export applicant data. DreamApply sends the following data:

Email address
Full name
Location/citizenship

The exported data is registered as subscriber records in MailerLite and placed into the selected group.

To export applicant data, perform the following tasks:

Obtain an API token
Configure integration settings

Before you begin

To integrate with DreamApply, your account must have the Superuser role or the integrations permission.

Language

Mon, 01 Jan 0001 00:00:00 +0000

Represents the language of the scoresheet score.

URI

/api/v9/scoresheets/ID/score/ID/language

Get the language

A request with the GET verb returns the score’s language code as JSON encoded string (or null, if there is no language stored).

Syntax

GET /api/v9/scoresheets/123/score/321/language
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/scoresheets/123/scores/321/language"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The language was successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"en"

Set the language

Set the language of a scoresheet score to a particular value.

Links

Mon, 01 Jan 0001 00:00:00 +0000

To add a link, wrap the link text in double quotes " followed by a colon : and provide the link URL.

The following URL protocols are whitelisted for links:

http
https
mailto
ftp

Local links

Local links point to pages within the DreamApply portal. You can use absolute or relative links, depending on your setup.

Link formatting

 Textile
 
This is an absolute link: "News":/en_GB/news/new/1-unlock-scholarship-opportunities

This is a relative link: "News":../new/1-unlock-scholarship-opportunities

Link formatting

 HTML
 
<p>This is an absolute link: <a href="/en_GB/news/new/1-unlock-scholarship-opportunities">News</a></p>

<p>This is a relative link: <a href="../new/1-unlock-scholarship-opportunities">News</a></p>

External links

External links point to other websites and require a full URL, including the protocol.

News

Mon, 01 Jan 0001 00:00:00 +0000

You can publish important updates, announcements and information directly on the DreamApply portal. News items can cover topics such as:

Upcoming events
Technical notices
Deadline reminders
Changes to admission criteria

News can be presented in various formats, including text or video.

All news items are displayed in the designated News section on the right side of the DreamApply welcome page. You can target each item to specific territories, like Europe or Asia, or individual countries. News visibility is based on the applicant’s citizenship, so only applicants from the selected regions will see the relevant announcements.

Remove programmes from the catalog

Mon, 01 Jan 0001 00:00:00 +0000

To remove a programme from the catalog, you can change its status to:

Archived: The programme is inactive but kept for historical records
Closed: The programme is no longer accepting applications

To maintain data accuracy, DreamApply keeps all programme data, even after a programme is archived or closed. Closed programmes are not deleted from the catalog. Institutions can re-open and update them at any time.

Before you begin

To change the programme status, your account must have the Superuser or Courses administrator role or the courses-view and courses-edit permissions.

Retain or delete invoices

Mon, 01 Jan 0001 00:00:00 +0000

In some situations, institutions may need to delete applicants and their data from DreamApply — either when applicants execute their right to be forgotten or due to an administrative decision. DreamApply offers two options for handling invoices issued to these applicants:

Preserve invoices
Delete invoices with other applicant data

DreamApply never deletes invoices that have been fully or partially paid. If any amount has been collected, the invoice is automatically preserved and stored as a detached record in the system.

Preserve invoices

Typically, institutions need to keep invoices for financial reporting and auditing, even after an applicant record linked to these invoices is deleted.

AI usage guidelines

Mon, 01 Jan 0001 00:00:00 +0000

Use the following guidelines to construct effective prompts and understand the limitations of AI outputs.

Prompt design guidelines

Define the task clearly: Specify the exact goal of the prompt in the Prompt text field. Clear instructions reduce ambiguity in AI responses.
Avoid formatting instructions: Avoid specifying custom output formats, such as using markdown, tables and other styling, in prompts. AI Highlighter uses the system prompt to control the AI output formatting, and overriding it at the prompt level may cause inconsistencies or errors.
Set the context explicitly: Provide enough context for the LLM to understand and complete the task. Include only relevant portions of application data and documents. Do not include confidential or sensitive information that must not be processed or stored by the LLM. Avoid sending excessive or unnecessary content, as the LLM can only process data within its context window.
Use safe and neutral language: Avoid language that may encourage biased or unsafe AI responses.
Specify exact dates: LLMs are trained on historical data up to a fixed cutoff date. As a result, their responses may lag behind and not reflect the current changes. To improve accuracy, design prompts with clear context and specific dates. For example, to consider the most recent information, you can use the %date-today% or %application-academicTerm-start% content marker in prompts.
Test and iterate: Run test prompts on sample applications to verify accuracy before you apply them to real submissions.

Limitations and considerations for AI outputs

Variation in AI responses: Running the same prompt multiple times may produce different results, even for similar inputs. LLMs generate responses probabilistically, which can lead to variations in phrases or structure. Do not expect outputs to be identical across applications.
Potential for hallucination: AI responses may include inaccurate, outdated or invented information. Always verify data against original source materials.
Biased responses: AI responses strongly depend on the LLM’s training data and may reflect biases. Always evaluate results for fairness and consistency.
Incomplete results: AI responses may sometimes be missing expected fields or data. Always check results for completeness.
Document parsing limitations: LLMs may not correctly interpret content of poorly formatted or scanned documents. Inconsistent document layouts, low resolution images or unusual font styles may result in incomplete or inaccurate data extraction.
System errors and processing limits: Some prompts may fail due to technical issues or LLM API constraints. Regularly monitor logs and review errors.

AI outputs are advisory. Always review the results and validate all extracted data before making any final decisions.

Application expiration

Mon, 01 Jan 0001 00:00:00 +0000

In DreamApply, an application is no longer active in the following cases:

An Administrator closes the application. To close an application, on the application card, click View and in the left pane, click Close application.
An applicant withdraws the application. Applicants can revert application withdrawal within 15 minutes.
The application has expired. DreamApply automatically marks all applications for the term as expired after the grace period for this term ends. At this point, the system locks the term and closes it for any other application changes or modifications by Administrators or applicants.

Limitations for expired applications

When an application expires, the following limitations apply:

Configure outgoing email settings

Mon, 01 Jan 0001 00:00:00 +0000

You can configure the following outgoing email settings in DreamApply:

Messaging mode: Select to use the regular or two-way messaging mode
Sender details:
- From name: The display name shown to the recipient as the sender.
- From email: The email address specified in the Reply-to field. If an applicant replies to the email, the reply will be sent to this address.

The actual sender email address is system-generated and cannot be changed. Using arbitrary email addresses in the From field is not allowed. For details, see How transactional emails work and Types of emails.

Before you begin

To define email settings, your account must have the Superuser role or the instance permission.

Images

Mon, 01 Jan 0001 00:00:00 +0000

The DreamApply support for image markup is limited. DreamApply renders images only in:

Footer that is automatically appended to email messages sent from the system. For details, see Configure outgoing email settings.
Letterhead templates. For details, see Use letterheads.

The following URL protocols are whitelisted for images:

http
https
mailto
ftp

To add an image, wrap the image link in exclamation marks !. You can use the title attribute for images.

Image formatting

 Textile
 
###. Image

!https://upload.wikimedia.org/wikipedia/commons/6/67/Uni_High_Urbana_illinois.jpg!

###. Image with a title

!https://upload.wikimedia.org/wikipedia/commons/6/67/Uni_High_Urbana_illinois.jpg(Image title)!

###. Image with a title and link

!https://upload.wikimedia.org/wikipedia/commons/6/67/Uni_High_Urbana_illinois.jpg(Image title)!:https://en.wikipedia.org/wiki/Campus

Image formatting

 HTML
 
<img alt="" src="https://upload.wikimedia.org/wikipedia/commons/6/67/Uni_High_Urbana_illinois.jpg">

<img alt="Image title" src="https://upload.wikimedia.org/wikipedia/commons/6/67/Uni_High_Urbana_illinois.jpg" title="Image title">

<a href="https://en.wikipedia.org/wiki/Campus"><img alt="Campus" src="https://upload.wikimedia.org/wikipedia/commons/6/67/Uni_High_Urbana_illinois.jpg" title="Campus"></a>

Integrate with Microsoft Dynamics 365

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply utilizes the Microsoft Dynamics 365 Customer Engagement Web API to integrate with Microsoft Dynamics 365.

During the export process, DreamApply can send the following data:

Applicant data: ID, name, first name, last name, email, phone, registration date, citizenship, reference and matriculation
Lead data: Lead stage and stage change date
Programme data: Programme IDs
Academic term data: Name, year, type and start date
Dates: Dates and UTC dates values

The exported data is registered as lead records in Microsoft Dynamics 365 and linked to a specific contact owner. You can map DreamApply applicant fields to corresponding fields of Microsoft Dynamics 365 records.

Manage cookies

Mon, 01 Jan 0001 00:00:00 +0000

When users access the DreamApply portal for the first time or after cleaning their browser cookies, DreamApply displays the cookie consent window. The window informs about the cookies that the system uses and allows users to grant their consent for data collection.

You can customize the cookie consent experience to ensure only necessary data is gathered. DreamApply offers the following options:

Implied consent: DreamApply displays an informative message about cookies at the bottom of the Confirm your citizenship window displayed to first-time visitors. When users set their citizenship, DreamApply assumes the consent is granted and it is allowed to send all marketing cookies.
Polite bar: DreamApply displays a consent bar at the bottom of the page. Users can accept all cookies or customize their settings.
Assertive dialog: DreamApply displays a consent window in the center of the page. Users can accept all cookies or customize their settings.

Users can change cookie settings at any moment using their browser.

Offer additional services

Mon, 01 Jan 0001 00:00:00 +0000

You can set up an inventory of additional services and items in DreamApply. Inventory items represent institution-specific offerings that applicants can choose to purchase during the admission process.

DreamApply allows setting up two types of inventory items:

Visible items shown to applicants directly in the DreamApply portal
Hidden items not publicly visible but accessible through a private link

Applicants get access to a full list of visible inventory items after they submit their applications. To purchase an item, they can add it to the shopping cart and complete the checkout process within the system.

Offer confirmation

Mon, 01 Jan 0001 00:00:00 +0000

Represents an offer confirmation.

Syntax

/api/v9/applications/ID/offers/ID/confirm
Host: apply.example.edu
Authorization: DREAM apikey="..."

Confirm an offer

This action confirms the offer and sends it out to the applicant using the current offer details:

Review and update the offer details before confirming the offer. Otherwise, DreamApply will proceed with the values most recently saved in the system.

Reference

Mon, 01 Jan 0001 00:00:00 +0000

Represents the reference of the scoresheet score.

URI

/api/v9/scoresheets/ID/score/ID/reference

Get the reference

A request with the GET verb returns the score’s reference metadata as JSON encoded string (or null, if there is no reference stored).

Syntax

GET /api/v9/scoresheets/123/score/321/reference
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/scoresheets/123/scores/321/reference"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The reference was successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"Diploma nr. 789"

Set the reference

Set the reference of a scoresheet score to a particular value.

System-wide notices

Mon, 01 Jan 0001 00:00:00 +0000

You can set up system-wide notices in the DreamApply portal. System-wide notices provide a way to broadcast important updates, system changes and operational alerts that need to be clearly visible to all relevant users.

System-wide notices can be targeted at specific user roles, such as Administrators, Advisors or applicants. When enabled, a notice appears as a warning bar at the top of the portal and is displayed to users when they log in.

Tables

Mon, 01 Jan 0001 00:00:00 +0000

To create tables, separate each table cell with the pipe symbol |.

Table formatting

 Textile
 
| Cell text | Cell text | Cell text |
| Cell text | Cell text | Cell text |

Table formatting

 HTML
 
 
<table>
 <tbody>
 <tr>
 <td>Cell text</td>
 <td>Cell text</td>
 <td>Cell text</td>
 </tr>
 <tr>
 <td>Cell text</td>
 <td>Cell text</td>
 <td>Cell text</td>
 </tr>
 </tbody>
</table>

Table caption

To add a table caption (the <caption> tag), start a line with |=. followed by the caption text. Place the caption immediately above the first row of the table or the table head.

Use letterheads

Mon, 01 Jan 0001 00:00:00 +0000

Your institution may need to send various types of confirmation letters to applicants at different stages of the admission process. These can include:

Official offer letters
Housing confirmations
Visa support letters
Financial and quotation letters

To ensure all official letters are consistent and compliant with your documentation policies, you can use letterhead templates in DreamApply.

Letterhead templates standardize the letter look and feel, including branding, layout and document text. They can also contain content markers, like the applicant’s name, programme and department, that are automatically replaced with actual data when the letter is generated.

Versioning and changelog

Mon, 01 Jan 0001 00:00:00 +0000

API versioning

The API version number only increments when backwards-incompatible changes are introduced or when the semantics or structure of data change significantly. For example, adding new data, such as a new field in the application, does not necessarily require a new version, as long as existing clients continue to work without disruption.

Maintaining backward compatibility is a high priority for DreamApply. However, when breaking changes are required, earlier API versions remain available for a limited time to allow clients to migrate.

Abbreviations

Mon, 01 Jan 0001 00:00:00 +0000

To use acronyms and abbreviations, write an abbreviation followed by its full term in parentheses.

An acronym or abbreviation must consist of three or more capitalized letters. Acronyms or abbreviations with mixed capitalization are not recognized.

Acronym and abbreviation formatting

 Textile
 
International applicants must submit their TOEFL(Test of English as a Foreign Language) or IELTS(International English Language Testing System) scores.

Acronym and abbreviation formatting

 HTML
 
<p>International applicants must submit their <acronym title="Test of English as a Foreign Language" class="titled"><span class="caps">TOEFL</span></acronym> or <acronym title="International English Language Testing System" class="titled"><span class="caps">IELTS</span></acronym> scores.</p>

Customize email templates

Mon, 01 Jan 0001 00:00:00 +0000

You can tailor the design, branding and content of transactional emails to match your institution identity and deliver the right message.

Customization options depend on the type of transactional emails. For authentication-related emails and emails sent to other parties, customization options are limited to email branding.

Before you begin

To customize email settings, your account must have the Superuser role or the following permissions:

instance permission to customize email branding
templates permission to customize email content
task-classes permission to customize task templates

Customize email branding

To adjust the logo and color scheme for transactional emails:

Define registration settings

Mon, 01 Jan 0001 00:00:00 +0000

You can customize the applicant registration process to make sure it meets the needs of your institution. In particular, you can allow applicants to define their types while registering and specify what information you want to collect.

Before you begin

To customize the registration settings, your account must have the Superuser role or the instance permission.

Adjust the registration page settings

To adjust the applicant registration process:

In the main menu, under System, select Settings.
In the Registration page settings section, under Applicants types, define the types applicants can choose while registering.
Specify if you want to display the Mobile phone and Reference code fields on the registration page.
At the top of the form, click Save changes.

Define support measures

Mon, 01 Jan 0001 00:00:00 +0000

Some applicants may require additional support to fully participate in the admission process. These include, for example, applicants with disabilities or applicants who have special needs. DreamApply lets institutions define support measures they can provide, assign them to applicants and later generate reports. This feature helps institutions improve accessibility in admissions and provide equal opportunities for all applicants.

Support measures can address different kinds of applicant needs. DreamApply organizes them into the following categories:

Integrate with Salesforce

Mon, 01 Jan 0001 00:00:00 +0000

During the export process, DreamApply can send the following data:

Applicant data: ID, name, first name, last name, email, phone, registration date, citizenship, reference and matriculation
Lead data: Lead stage and stage change date
Programme data: Programme IDs
Academic term data: Name, year, type and start date
Dates: Dates and UTC dates values

The exported data is registered as lead records in Salesforce and linked to a specific contact owner. You can map DreamApply applicant fields to corresponding fields of Salesforce records.

Offer decision

Mon, 01 Jan 0001 00:00:00 +0000

Represents the application offer decision.

Syntax

/api/v9/applications/ID/offers/ID/decision
Host: apply.example.edu
Authorization: DREAM apikey="..."

Get the offer decision

A request with the GET verb returns the decision that the applicant has made (or has been made by admin on behalf of the applicant) regarding this offer.

It can be one of three:

Final: The offer was accepted by the applicant
Declined: The offer was declined by the applicant
None: No decision yet

Syntax

GET /api/v9/applications/123/offers/321/decision
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/offers/321/decision"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The decision was successfully returned
`404 Not Found`	The application does not have this offer

Example response

Response

"Declined"

Set the offer decision

Set the decision on behalf of the applicant regarding a specific offer. For example, you can mark an offer to be declined, or make it the final decision (acceptance) for an applicant.

Subject

Mon, 01 Jan 0001 00:00:00 +0000

Represents the subject of the scoresheet score.

URI

/api/v9/scoresheets/ID/score/ID/subject

Get the subject

A request with the GET verb returns the score’s subject metadata as JSON encoded string (or null, if there is no subject stored).

Syntax

GET /api/v9/scoresheets/123/score/321/subject
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/scoresheets/123/scores/321/subject"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The subject was successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"Mathematics"

Set the subject

Set the subject of a scoresheet score to a particular value.

Use channels

Mon, 01 Jan 0001 00:00:00 +0000

To understand how applicants learned about your institution, you can use channels. Channels represent the sources through which applicants discover or access the admissions portal. Common channels include:

University website
Internet search engines
Social media platforms
Educational fairs

When an applicant submits an application, you can set up DreamApply to collect the channel information and automatically assign a channel flag that identifies the selected source to the application. Channel flags can then be used to filter and analyze applications during the admission process.

What's new in DreamApply API

Mon, 01 Jan 0001 00:00:00 +0000

Stay up-to-date with the new API features and capabilities available in the latest and previous versions of the DreamApply API. If you are looking for a concise, version-by-version summary of important updates, see the Changelog.

May 2026

Attachment

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single attachment to an email sent to an applicant.

URI

/api/v9/applicants/ID/emails/ID/attachments/ID

Download an email attachment

Download a specific attachment.

Syntax

GET /api/v9/applicants/123/emails/1/attachments/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applicants/123/emails/321/attachments/1"

Response headers

Header	Value	Description
`Content-Type`	`application/octet-stream`	Media type of the resource

Response codes

Response code	Description
`200 OK`	The email attachment data was successfully returned
`404 Not Found`	The email has no attachments

References

Mon, 01 Jan 0001 00:00:00 +0000

You can use the following types of references:

Citations
Block quotations
Footnotes

Citations

To mark a citation, wrap the text in double question marks ??. Use double dashes -- at the start of a new line to define the author.

Citation formatting

 Textile
 
??The function of education is to teach one to think intensively and to think critically.??
-- Martin Luther King Jr.

Citation formatting

 HTML
 
 
<p>
 <cite>The function of education is to teach one to think intensively and to think critically.</cite>
 <br />
 — Martin Luther King Jr.
</p>

Block quotations

To use a block quotation, start a line with bq.. For more than one paragraph in the block quotation, use bq...

Send applicant data

Mon, 01 Jan 0001 00:00:00 +0000

You can configure DreamApply to send applicant data to connected systems in the following ways:

Automatically
Through rules
Manually

Automatically send applicant data

You can set up DreamApply to automatically send new applicant data to a connected system. To do this, enable the Update applicant records automatically option and select a contact owner or group/audience to which exported records must be linked or placed.

With this option enabled, DreamApply will continuously scan for new applicants who register themselves, are registered by an Advisor or are collected through the Import tool. When a new record is detected, DreamApply will send its data to the connected system. The data transfer is triggered by specific journal events such as:

Unsubscribe from emails

Mon, 01 Jan 0001 00:00:00 +0000

If applicants no longer want to receive notifications from DreamApply, they can unsubscribe from transactional emails.

DreamApply offers several ways to unsubscribe:

Visit the Unsubscribe link: Transactional emails sent by DreamApply include an Unsubscribe link at the bottom of emails. When applicants click the link, they will be directed to a page where they can adjust their email settings.
Use the Unsubscribe button in the email: DreamApply includes the list-unsubscribe header in its emails. Some email clients such as Gmail or Apple Mail display the Unsubscribe button at the top of the email. Applicants can click the button, and the email client will automatically process the unsubscribe request using its native tools.
Adjust profile settings: Applicants can use the Email unsubscribe option in the My profile settings in the Applicant portal. If they decide to resume receiving notifications, they can disable this option again later.

Mind the following:

Unsubscribing stops transactional emails sent to applicants. Applicants will still receive emails they have requested explicitly, for example, when logging in with a one-time link.

Code formatting

Mon, 01 Jan 0001 00:00:00 +0000

You can use the following formatting to format code:

Code blocks
Pre-formatted text

Code blocks

To use a code block, start a line with bc. For code blocks with empty lines, use bc...

Code block formatting

 Textile
 
 
bc. // This is a simple code block
console.log("Hello, World!");

bc.. // This is a code block with empty lines
const GREETING = 'Hello'; //
const SEPARATOR = ', ';
const SUBJECT = 'World';
const PUNCTUATION = '!';

/**
 * A helper function to combine the message parts.
 * @returns {string} The full "Hello, World!" message.
 */
function generateMessage() {
 const fullMessage = `${GREETING}${SEPARATOR}${SUBJECT}${PUNCTUATION}`;
 return fullMessage;
}

Code block formatting

 HTML
 
 
<pre>
 <code>
 // This is a code block with empty lines
 const GREETING = 'Hello'; //
 const SEPARATOR = ', ';
 const SUBJECT = 'World';
 const PUNCTUATION = '!';

 /**
 * A helper function to combine the message parts.
 * @returns {string} The full "Hello, World!" message.
 */
 function generateMessage() {
 const fullMessage = `${GREETING}${SEPARATOR}${SUBJECT}${PUNCTUATION}`;
 return fullMessage;
 }
 </code>
</pre>

Pre-formatted text

To use pre-formatted text, start a line with pre. For formatted text with empty lines, use pre...

Monitor data export

Mon, 01 Jan 0001 00:00:00 +0000

When you initiate data export, DreamApply creates a separate job for each applicant record to process. You can monitor the export progress and check for any failures.

To view the list of created jobs, in the integrations list, to the right of the integration gateway, click the wrench icon and select Jobs.
To view the list of failures and their details, in the integrations list, to the right of the integration gateway, click the wrench icon and select Failures.

Failure types

DreamApply can report two types of failures during data transfer:

Horizontal line

Mon, 01 Jan 0001 00:00:00 +0000

To add a horizontal line that defines a break between content sections, add three hyphens - on a line by themselves.

Horizontal line formatting

 Textile
 
This is the end of the first content section.

---

This is the beginning of the second content section.

Horizontal line formatting

 HTML
 
<p>This is the end of the first content section.</p>

<hr>

<p>This is the beginning of the second content section.</p>

Scores

Mon, 01 Jan 0001 00:00:00 +0000

Represents a list of scores for the application.

URI

/api/v9/applications/ID/scores

List scores

Return a list of scores for the application.

Syntax

GET /api/v9/applications/123/scores
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/scores"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`2`	Number of scores for this application

Response codes

Response code	Description
`200 OK`	The list of scores was successfully returned

Example response

Response

 
 
 
{
 "20": {
 "scored": "2025-12-11T11:49:45+00:00",
 "scoresheet": "/api/v9/scoresheets/1",
 "application": "/api/v9/applications/415",
 "offer": null,
 "points": "9.50",
 "comments": "Strong candidate",
 "date": null,
 "reference": null,
 "subject": null,
 "language": null
 },
 "21": {
 "scored": "2025-12-11T11:48:52+00:00",
 "scoresheet": "/api/v9/scoresheets/9",
 "application": "/api/v9/applications/415",
 "offer": null,
 "points": "1450",
 "comments": "SAT Score breakdown: EBRW 720 / Math 730",
 "date": "2025-03-09",
 "reference": "SAT-2025-5620",
 "subject": "SAT (Scholastic Assessment Test)",
 "language": "EN"
 }
}

Tracker

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single tracker set on an applicant. For a tracker created in the system, see Tracker (global).

URI

/api/v9/applicants/ID/trackers/ID

Get a tracker

Get information about a specific tracker set on an applicant.

This request does not return the tracker itself, but rather represents the relationships between the applicant and the tracker. Follow the tracker URI in the response to retrieve further information about the tracker in question.

Page break

Mon, 01 Jan 0001 00:00:00 +0000

To add a page break between content sections, add three underscores _ on a line by themselves.

The page break markup is supported only in printed materials (letterheads).

Page break formatting

 Textile
 
h1. Heading

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

This is the end of the first page.

___

This is the beginning of the second page.

PDF

Mon, 01 Jan 0001 00:00:00 +0000

Represents a PDF printout of the application.

URI

/api/v9/applications/ID/pdf

Generate a PDF printout

Retrieve a PDF printout of the application, replicating the Save as PDF feature in the user interface.

The PDF conversion is happening in real time and may take a few seconds to process on larger applications. The API request is also subject to modest throttling, so you may need to slow down your requests when fetching a large number of PDFs.

Report

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single report.

URI

/api/v9/reports/ReportName

Get report data

The report’s contents as CSV data. You may use the HEAD verb to see the size of the CSV data if you want to decide if it is worth downloading it.

Syntax

GET /api/v9/reports/ReportTrackersApplicantDetails
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Each report will require a different set of parameters. If any one of them is not properly set, an error will be returned, listing the unset parameters. Use this functionality to learn which report will require which parameter.

Invoice

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single invoice issued to the applicant.

URI

/api/v9/applicants/ID/invoices/ID

However, in order to not destroy accounting records, invoices are the only data that is preserved after an applicant record is destroyed. To achieve this, invoices are detached from the applicant records, losing this association. This is why in the admin UI they are distinctive with a gray anonymous icon and also why in the API response the applicant and application field is set to null.

Alignment and indentation

Mon, 01 Jan 0001 00:00:00 +0000

You can align and indent text blocks to structure content, visually separate sections and improve readability.

Alignment and indentation can be applied to block-level elements:

Align elements

To align elements, add an alignment character right before the period . that denotes the block type, such as heading or paragraph.

You can use the following alignment characters:

< to left-align the content block
> to right-align the content block
= to center the content block

Element alignment

 Textile
 
h1=. Centered heading

p>. This is a right-aligned paragraph.

p<. This is a left-aligned paragraph.

pre>.. This is a right-aligned pre-formatted text block.

And another line of the pre-formatted text block.

Element alignment

 HTML
 
<h1 style="text-align: center">Centered heading</h1>

<p style="text-align: right">This is a right-aligned paragraph.</p>

<p style="text-align: left">This is a left-aligned paragraph.</p>

<pre style="text-align: right">This is a right-aligned pre-formatted text block.

And another line of the pre-formatted text block.</pre>

Indent elements

To indent elements, add an indentation character (or characters) right before the period . that denotes the block type, such as heading or paragraph.

Disable character conversion

Mon, 01 Jan 0001 00:00:00 +0000

To improve readability, Textile automatically converts certain characters, for example, ", ', (R) and &. For a full character list, see the Textile documentation.

To suppress conversion, use the following methods:

Inline suppression: To preserve characters inline, wrap the text in ==.
Block suppression: To disable conversion for a text block, start a line with notextile..

Character conversion

 Textile
 
(c) 2026 DreamApply

== (c) == 2026 DreamApply

notextile. (c) 2026 DreamApply

Character conversion

 HTML
 
<p>© 2026 DreamApply</p>

<p>(c) 2026 DreamApply</p>

(c) 2026 DreamApply

Wishlist item

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single item on the applicant’s wishlist.

URI

/api/v9/applicants/ID/wishes/ID

Get a wishlist item

Retrieve information about a particular applicant wishlist item. This represents a course that the applicant has shown interest towards, but is not yet added to any application. An applicant may collect interesting courses to his wishlist for later application or further evaluation.

Syntax

GET /api/v9/applicants/123/wishes/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applicants/123/wishes/1"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The item on the applicant wishlist is returned
`404 Not Found`	The applicant wishlist item was not found

Example response

Response

 
 
 
{
 "wished": "1970-01-01T00:00:01+00:00",
 "applicant": "/api/v9/applicants/60",
 "course": "/api/v9/course/1",
 "intake": null,
 "notes": null
}

Application

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single application submitted by the applicant.

URI

/api/v9/applicants/ID/applications/ID

Get an application

Retrieve information about a particular applicant application.

Syntax

GET /api/v9/applicants/123/applications/321
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applicants/123/applications/321"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The application data was successfully returned

Example response

Response

 curl
 
 
{
 "profile": {
 "name": {
 "given": "Test",
 "family": "Name"
 },
 "id": "38501234567",
 "passport": {
 "number": "K21815615611",
 "issue": "2002-02-28",
 "expiry": "2010-02-15"
 },
 "birth": {
 "date": "1982-01-28",
 "place": "Tallinn"
 },
 "nationality": "EE",
 "citizenship": "EE",
 "gender": "M",
 "maritial": "M",
 "family": {
 "mother": "Mother Name",
 "father": "Father Name",
 "guardian": "Some Name"
 }
 },
 "contact": {
 "address": {
 "street": "Some Street 40-15",
 "municipality": "Tallinn",
 "postalcode": "10142",
 "country": "EE"
 },
 "telephone": {
 "day": "+372 646 12 34",
 "evening": "+372 646 12 34",
 "mobile": "+372 53 404 137",
 "fax": "+372 53 404 137"
 },
 "email": "lauri@somesite.ee",
 "emergency": {
 "name": "Name Somebody",
 "telephone": "+372 21 55656"
 }
 },
 "education": [
 {
 "type": "SE",
 "course": "",
 "graduation": {
 "mm": "05",
 "yy": "2004"
 },
 "institution": "Tallinna 21. Kool",
 "country": "EE"
 },
 {
 "type": "BA",
 "course": "High School Diploma",
 "graduation": {
 "mm": "",
 "yy": "2007"
 },
 "institution": "Some Business School",
 "country": "EE"
 },
 {
 "type": "IN",
 "course": "Some other programme",
 "graduation": {
 "mm": "05",
 "yy": "2001"
 },
 "institution": "Some Organization",
 "country": "US"
 }
 ],
 "languages": {
 "0": {
 "name": "lv",
 "proficiency": "B",
 "experience": "5",
 "information": ""
 },
 "1": {
 "name": "en",
 "proficiency": "P",
 "experience": "5",
 "information": "TOEFL PAPER 550"
 },
 "2": {
 "name": "de",
 "proficiency": "I",
 "experience": "5",
 "information": ""
 },
 "native": "et"
 },
 "career": [
 {
 "employer": "Some Company OÜ",
 "position": "Head of Development",
 "period": {
 "from": {
 "yy": "2007",
 "mm": ""
 },
 "to": {
 "yy": "2008",
 "mm": ""
 }
 },
 "weekly": ""
 },
 {
 "employer": "Some Company OÜ",
 "position": "Head of Development",
 "period": {
 "from": {
 "yy": "2008",
 "mm": "05"
 },
 "to": {
 "yy": "2010",
 "mm": "12"
 }
 },
 "weekly": "15"
 }
 ],
 "activities": [
 {
 "organization": "Some organization",
 "nature": "some role description",
 "period": {
 "from": {
 "yy": "2007",
 "mm": ""
 },
 "to": {
 "yy": "2009",
 "mm": "11"
 }
 }
 }
 ],
 "residences": [
 {
 "country": "FR",
 "purpose": "Training",
 "period": {
 "from": {
 "yy": "2007",
 "mm": "05"
 },
 "to": {
 "yy": "2008",
 "mm": "06"
 }
 }
 },
 {
 "country": "LT",
 "purpose": "Studying",
 "period": {
 "from": {
 "yy": "2007",
 "mm": "05"
 },
 "to": {
 "yy": "2008",
 "mm": "06"
 }
 }
 }
 ],
 "motivation": {
 "general": "\n Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sem lacus, pellentesque sed cursus sed, ultrices ac orci. Mauris orci nulla, convallis ut semper id, bibendum eu purus. Duis ornare pellentesque nisl, non condimentum augue pellentesque id. Vestibulum mauris felis, convallis id congue vel, dapibus ac ipsum. Vivamus ipsum nisl, imperdiet eget facilisis id, porta hendrerit erat. Nulla facilisi. Aliquam mollis hendrerit urna. Morbi porttitor neque eget justo congue pretium. In ipsum turpis, tincidunt ut commodo nec, viverra sed odio. Donec sit amet lacinia neque. Nam varius sodales tristique. Vivamus rutrum facilisis mauris a dictum. Vestibulum nibh nulla, luctus sit amet malesuada vel, aliquam in urna.\n \n Nullam nisl ipsum, cursus at pharetra ut, porta in dui. Aenean rutrum, massa at rhoncus aliquet, risus justo imperdiet eros, eget interdum nunc neque a lorem. Donec luctus feugiat tincidunt. Suspendisse elementum velit vel nisl mollis non hendrerit arcu eleifend. Fusce vel porttitor est. Maecenas eget tortor ut massa auctor interdum. Nulla facilisi. Nulla facilisi. Vestibulum ac tellus a sem imperdiet tristique. Morbi mauris orci, convallis nec blandit eget, scelerisque nec sem. Ut in turpis et diam porttitor pellentesque. Integer tellus neque, tincidunt luctus malesuada sed, luctus id justo. Nullam nec arcu et ipsum cursus bibendum. Cras sed metus ullamcorper urna posuere posuere. Praesent quis tellus nunc, vitae laoreet orci. Cras blandit iaculis sem eget faucibus.\n \n Donec ullamcorper, est nec rutrum tristique, dui nibh molestie sapien, nec aliquam risus dolor vel enim. Donec in eleifend justo. Quisque leo odio, rutrum eget consectetur at, tempus eu erat. Praesent a purus mi. Suspendisse potenti. Pellentesque vulputate pharetra erat, non commodo urna pretium a. Sed id nisi orci. Pellentesque vestibulum scelerisque tellus ut auctor. Sed ut libero a justo gravida semper nec nec turpis.\n \n Mauris faucibus elit sit amet tellus condimentum convallis. Sed consectetur semper nisl, at sagittis mi pulvinar eget. Sed diam nisl, tincidunt id congue ac, dapibus nec odio. Donec vitae lorem sed nunc aliquam tristique. Mauris convallis mollis tellus, vitae pharetra nulla elementum at. Aliquam viverra accumsan ipsum. In placerat porttitor pharetra. Quisque ipsum nulla, varius a congue vitae, sodales vitae quam. Mauris non metus sed odio ornare rhoncus vel ac nisl. Suspendisse potenti. In at turpis neque. Nam diam tellus, molestie in tincidunt ac, semper eget diam. \n "
 },
 "extras": [],
 "misc": {
 "medical": "",
 "additional": ""
 },
 "studyplan": "",
 "created": "2014-06-20T08:30:31+00:00",
 "revised": "2014-06-20T08:30:31+00:00",
 "submitted": null,
 "status": "Prepare",
 "commence_year": "2013",
 "applicant": "/api/v9/applicants/60",
 "flags": "/api/v9/applications/60/flags",
 "courses": "/api/v9/applications/60/courses",
 "offers": "/api/v9/applications/60/offers",
 "exports": "/api/v9/applications/60/exports",
 "documents": "/api/v9/applications/60/documents"
}

Content styling

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply does not support custom CSS in Textile content. To control the visual appearance of text, use the DreamApply styling options instead of inline CSS.

Letterheads

You can control styling through letterhead settings. These settings allow you to manage:

Page margins
Font family
Text size
Line spacing
Table border style

Web-based content

For portal pages and system messages, you can control styling through the DreamApply system settings. These settings allow you to manage:

Content control

Mon, 01 Jan 0001 00:00:00 +0000

To mitigate common web vulnerabilities, DreamApply applies the following limitations to content formatting:

HTML removal: Raw HTML tags are not supported and removed from the output.
Protocol whitelisting: URL protocols for links and images are strictly limited to a safe whitelist:
- http: Standard web pages
- https: Secure web pages
- mailto: Email links
- ftp: File transfer
Other protocols, such as file, tel, callto and sftp, are disallowed.
Inline styles disabled: Inline CSS styles cannot be applied to elements.

Reference code

Mon, 01 Jan 0001 00:00:00 +0000

Represents the reference code for the applicant.

URI

/api/v9/applicants/ID/reference

Get a reference code

A request with the GET verb returns the JSON-encoded reference value for this applicant. Note that the value appears to be a double-quoted value, but is a JSON string literal in the strict sense. If there is no reference value, null is returned.

A reference value can be anything, usually it is the applicant’s ID or code in another related system, for example the applicant’s student ID in the Study Information System (SIS).

Matriculation number

Mon, 01 Jan 0001 00:00:00 +0000

Represents the matriculation number for the applicant.

URI

/api/v9/applicants/ID/matriculation

Get a matriculation number

A request with the GET verb returns the JSON-encoded matriculation number for this applicant. Note that the value appears to be a double-quoted value, but is a JSON string literal in the strict sense. If there is no matriculation number, null is returned.

Syntax

GET /api/v9/applicants/123/matriculation
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applicants/123/matriculation"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The matriculation number was successfully returned

Example response

Response

 curl
 
"ABC123"

Set a matriculation number

When making a PUT request, the contents of the request body will be stored as the new matriculation number for the applicant in question.

Prompt library

Mon, 01 Jan 0001 00:00:00 +0000

Browse our library of AI Highlighter prompts maintained by the DreamApply Configuration Team.

Admissions Faculty Finance Compliance Cross-functional

Admissions

Application Completeness Check

Quick triage: is the application ready for review?

Prompt settings:

Output: Label
Temp: 0.15
Values: Complete Incomplete Partially complete other

View all prompt details

Prompt text:

Check whether this application is complete.

Verify:
1. Required form sections are filled.
2. Required uploads are present: %application-tasks-status(*)%
3. Motivation letter has substantive content: %application-motivation%

Context materials:

All sections, All tasks

Note

Mon, 01 Jan 0001 00:00:00 +0000

Represent a single note on the applicant.

URI

/api/v9/applicants/ID/notes/ID

Get a note

A request with the GET verb returns information about one specific (sticky) note on the applicant record.

Syntax

GET /api/v9/applicants/123/notes/321
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applicants/123/notes/321"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The note data was successfully returned

Example response

Response

 curl
 
 
{
 "created": "1970-01-01T00:00:01+00:00",
 "removed": null,
 "colour": "Yellow",
 "pinned": false,
 "collapsed": false,
 "Notes": "Some comments"
}

Response

 curl
 
"Some comments"

Update a note

Update one specific applicant (sticky) note.

Knowledge Base on DreamApply Knowledge Base

Academic term

GET Get an academic term

Example request

Response headers

Response codes

Example response

Catalog setup basics

Programme catalog structure

Citizenships

Configure task templates

Consent (global)

GET Get a consent

Example request

Response headers

Response codes

Example response

Create scoresheets

Before you begin

Add scoresheets

Create trackers

Before you begin

Customize the portal identity and branding

Before you begin

Data collection basics

Roles and responsibilities

Define applicant categories

How applicant categories are used

Category visibility modes

Entry point basics

Export data to a spreadsheet

Before you begin

Step 1. Connect DreamApply to Zapier

Finance basics

Fees

Flag

GET Get a flag

Flag (global)

GET Get a flag

Example request

Response headers

Example response

DELETE Delete a flag

Getting started with Textile

Step 1. Locate the front-segment

Grants and scholarships basics

Budgets

Headings

How data transfer works

How gateway payments work

How Google integration works

How incoming integrations work

How Matomo integration works

How outgoing integrations work

Applicant data export

How Zapier integration works

ID conventions

Interview basics

Invoice

GDPR information

Manage access to meetings

Manage fees

Messaging modes

Regular messaging mode

Offer basics

Offer workflows

Offer letter

GET Get an offer letter

Offer note

GET Get an offer note

Example request

Response headers

Response codes

Example response

PUT Edit an offer note

Organize applications

Before you begin

Set application limits

Organize invoices

Purge applications

Get an academic term

Get a consent

Get a flag

Get a flag

Delete a flag

Get an offer letter

Get an offer note

Edit an offer note

Get a reference

Download attached documents

Download attached documents

Get an academic year

Get an administrator

Freeze an application

Get a course