The "pull" method will direct the relevant prospect data to your CRM through the API connection. This article will assist with your pull API implementation and ensure data is pulled to your CRM.
To build your custom connector and implement the API connection, your API build team needs to follow these steps:
Request an API key from the Unibuddy support team. If you have an active API key from a previous API connection, this can be used for your new pull connection. An alternative key will not be required. You can contact support using the chat bubble in your University Dashboard.
The API URL to be used in this instance is; https://api.unibuddy.co/v1/batch_applicant/all/stagetwo?token=&startDate=&endDate=
2.1 The start date and time in the URL need to be added by your build team and should be in the following format:
YYYY-MM-DDTHH:MM:SS.sssZ (2021-12-15T10:00:00.609Z)
PLEASE NOTE: The start date and time is from the specified moment data should be pulled, this can not be backdated. The timezone is UTC (coordinated universal time).
2.2 The end date and time in the URL need to be added by your build team and should be in the following format:
YYYY-MM-DDTHH:MM:SS.sssZ (2021-12-15T10:00:00.609Z)
PLEASE NOTE: The end date and time is the date and time that the data will be pulled until. The timezone is UTC (coordinated universal time).
Applicant Data Sample
Http Response: status_code: http status code. 200 indicates success mimetype = “text/csv” data = b'id,firstName,lastName,email,created,acceptMarketing,country,conversations,messages,ha sApplied,signUpLocation,degreeLevel,degreesInterested,liveEvents,labels,dateOfEntry,cust omField1Name,customField2Name\r\n60e5d7a18a5b8593656926a5,Jane,Doe,[email protected],2021-07-07 16:34:40.816000,True,UK,0,0,,University Widget,,Software Engineering,My event,,2001-09-07 00:00:00,customField1Valuel,customField2Value\r\n'