Before you can make your first bulk import request, you need to have set up the Grid Squid environment.

‍

Please follow steps in either of the below Quick Start guides to setup your environment:

• Set up Environment using UI
• Set up Environment using API

You can add either raw record or transformed record to your linked CRM:

‍

Add a Raw Record (Mapping is not required)

‍

To add a RAW record into your CRM, you'll have to make a Make a POST request to:

<YOUR_API_URL>/users/{user_id}/records/raw/{crm_object_name}

‍

Add a Transformed Record (Mapping is required)

‍

To add a TRANSFORMED record into your CRM, you have to make a Make a POST request to:

<YOUR_API_URL>/users/{user_id}/records/unified/{badger_object_name}

‍

Request Parameters

For both of these request options, you'll need to substitute in the following parameters: 

• YOUR_API_ URL: this is the URL to access the unified Grid Squid API provided by us after you have requested access.
• user_id: this is the id of the user whose CRM account will be accessed to add the requested data (objects). You can get this user_id either by going to the users section in the UI, or by making a GET request to pull user information - more on that option in our API Reference.
• crm_object_name: This is the name of the CRM Object who's fields will be retrieved. You can get the crm_object_name by making a GET request to pull the CRM Metadata information as mentioned in our API Reference.

‍

Request Body

To create a request body, you'll need to provide key-value pairs for all mandatory fields of the object you are working with.

‍

Step 1: Get the List of Object Fields

Start by retrieving a list of all the fields for the object.

Make a GET request to:

<YOUR_API_URL>/users/{user_id}/metadata/objects/{crm_object_name}/fields

‍

This request will return the full list of fields associated with the object, along with information on which fields are mandatory.

‍

Step 2: Build the Request Body

Using the information from Step 1, construct the request body by including all mandatory fields and their corresponding values. Fields that are not mandatory can be included but are optional.

Here’s an example of what your request body should look like:

{
field_1_name: 'value for field_1',
field_2_name: 'value for field_2',
field_3_name: 'value for field_3',
field_4_name: 'value for field_4'
}

‍

Notes:

• Mandatory Fields: These are required and must be included in your request body.
• Optional Fields: These can be left out unless you need to provide specific values for them.

By following these steps, you’ll ensure your request is properly formatted and meets the API requirements.

‍