You can use Haiilo's API to update a user's profile fields with information. Below, we'll show an example of how you can find and update a user's profile with Postman in just a few steps.
To make calls to the Haiilo API, you need to authenticate first. You can find detailed information about authenticating and using the API here.
Step 1: List your users' profile information
- Make a GET request to the endpoint
/api/users/
to get a list of your users, including their profile information
You can see an example of what the response might look like below. Under Properties, you can see the available profile fields for a user. If a profile field is empty, it will show null
.
-
{
"tenant": "9dba828f-623b-45de-9067-xxxxxxxxx",
"loginName": "susanne.miller@haiilo.com",
"loginNameAlt": "sm",
"moderatorMode": false,
"status": "ACTIVE",
"active": true,
"anonymized": false,
"firstname": "Susanne",
"lastname": "Miller",
"email": "susanne.miller@haiilo.com",
"language": "EN",
"timezone": "America/New_York",
"properties": {
"xing": null,
"about": null,
"phone": "+1 212 2345678",
"skype": null,
"mobile": "+1 212 2345678",
"office": "Remote",
"company": "Haiilo Inc.",
"twitter": null,
"website": "https://www.haiilo.com",
"birthday": "1990-08-08",
"facebook": null,
"homeTown": "Hickory, North Carolina",
"jobTitle": "Internal Communications Manager",
"linkedin": null,
"location": "New York City, New York",
"projects": null,
"education": null,
"expertise": null,
"interests": "Nature photography, swimming",
"languages": "English, Spanish",
"department": "Communications",
"roomnumber": "42",
"haiilo_pronouns": "they/them"
},
"manager": null,
"updatedId": 364,
"id": "106def2b-b36b-48c6-88dd-xxxxxxx",
"entityId": {
"id": "106def2b-b36b-48c6-88dd-xxxxxxx",
"typeName": "user"
},
"slug": "susanne-miller",
"typeName": "user",
"displayName": "Susanne Miller",
"displayNameInitials": "SM",
"color": "#7e63a6",
"target": {
"name": "user",
"displayName": null,
"params": {
"id": "106def2b-b36b-48c6-88dd-xxxxxxx",
"slug": "susanne-miller"
}
},
"externalWorkspaceMember": false,
"imageUrls": {
"cover": "/api/senders/106def2b-b36b-48c6-88dd-xxxxxxx/images/cover?modified=1694611334192",
"avatar": "/api/senders/106def2b-b36b-48c6-88dd-xxxxxxx/images/avatar?modified=1694688826731"
},
"public": true
}
You can also add to the available profile fields for your users via the API; learn more in API: Customizing profile fields.
Step 2: Fill profile fields for a user
You can fill information into a user's profiles as follows:
- Copy the fields that you want to fill in from the response. Start the raw text with a { and end with a }. E.g.,
{ "projects": null,
"education": null,
"expertise": null } - Enter the copied fields in the request body.
- Add the desired information for each profile field inside double quotation marks.
- In our example, we are adding information for projects, education, and expertise:
{
"projects": "IC Restructuring",
"education": "Bachelor of Communications",
"expertise": "Everything"
}
- In our example, we are adding information for projects, education, and expertise:
- Make a POST request to the endpoint
/api/users/<user_id>/profile/fields
You should receive a 204 No Content
response. Make another GET request or check the user's profile on the platform to verify the information has been added.
If you encounter errors when calling the API, one frequent source is the body syntax. Please ensure that all brackets are closed, all parameters are in quotation marks, and there are commas between the individual fields in the list.