How to Create/Update an Object on Monosync using API

This document will help you to create/update an object on MonoSync. Before you continue, you need to make sure that you have valid Api Key generated for your tenant.

📘 Instructions

This document will contain 3 steps.

1. Create Object (POST)

2. Update Object with specified fields (PATCH)

3. Update Object (PUT)

The Api Key is required to make the operations on MonoSync. You can see an example below.

You can use Postman for HTTP request to make operations on MonoSync.

Let’s start creating Object Type on MonoSync.

To create an Object Type on MonoSync, navigate to MonoSync Object Type Create page by clicking Object Types button and click Create button in the upper right corner.

Once you navigated to Object Type Create page, please create fields based on your fields on HR System and save the Object Type by clicking Save button in the upper right corner.

After Object Type Creation process completed on MonoSync, you can continue with making operations using Postman.

1-) Create Object (POST)

To create object on MonoSync on specific object type, please select the HTTP method to be POST, write the Request URL based on your domain, specify the Request Body as shown and click the Send button.

Once object is created on MonoSync, you can see it on the “HR Users“ object list that created before.

2-) Update Object with Specified Fields (PATCH)

To update the object on MonoSync on specific object type with specified fields, please select the HTTP method to be PATCH, write the Request URL based on your domain, specify the Request Body as shown and click the Send button.

For Example: If you would like to update object’s FirstName and LastName on MonoSync, the entire object doesn’t need to send in the request body. Only FirstName and LastName field can be send in the request body. Because the PATCH method will update the object with only specified fields on MonoSync.

3-) Update Object (PUT)

To update the entire object on MonoSync on specific object type, please select the HTTP method to be PUT, write the Request URL based on your domain, specify the Request Body as shown and click the Send button.

For Example: If you would like to update object’s LastName and EmployeeEndDate on MonoSync, the entire object needs to send in the request body. Because the PUT method will update the entire object on MonoSync.

Once object is update on MonoSync, you can see it on the “HR Users“ object list that created before.