Add records

Add new records to a module and receive the record IDs upon a successful API call. The records include contacts, pipelines, companies, products, events, calls, and so on.

Endpoints

POST /{module_api_name}

Request URL

{api-domain}/bigin/v2/{module_api_name}

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with one of the following scopes:

ZohoBigin.modules.ALL
ZohoBigin.modules.{module_name}.ALL
ZohoBigin.modules.{module_name}.WRITE
ZohoBigin.modules.{module_name}.CREATE

In the above scope, replace {module_name} with the module to which the records being added belongs. The possible modules include contacts, accounts (companies in Bigin), products, calls, events, and tasks.

Notes:

Send only one JSON object in the input to insert a single record.
If the length of a field value exceeds the specified maximum length, an error will occur.
If you are using the API inside a Function and the length of a field value exceeds the limit, the Function will receive an error response from the API. For example, if the maximum length for a "Text field" is defined as 10, providing a value like "12345678901" with 11 characters will result an error.
The API performs duplicate checks for every add record API call based on unique fields. Make sure that you avoid inserting duplicate records by providing unique values for the designated fields.
A maximum of 100 records can be inserted per API call.
Use only the Field API names in the input. To obtain the Field API names, you can make use of the Fields metadata API. Look for the value corresponding to the key api_name for each field.
The trigger input for the API is "workflow". If you do not specify a trigger value, the workflows associated with the API will be executed. To prevent the execution of workflows, provide the trigger value as an empty array, i.e., [].

Request parameters

The available request parameters are given below:

Path parameters

module_api_name stringRequired

The API name of the module. The possible modules for this endpoint and their API name are given below:

Module	API Name
Contacts	Contacts
Pipelines	Pipelines
Companies	Accounts
Products	Products
Tasks	Tasks
Events	Events
Calls	Calls

Body parameters

Before you construct request body for each module, you should be familiar with the following:

System-defined mandatory fields for each module

Each module in Bigin requires certain system-defined mandatory fields when adding records. Additionally, make sure to provide the necessary user-defined mandatory fields for successful record insertion.

Module	System-defined mandatory fields	Field type in Bigin
Contacts	Last_Name	Single Line
Pipelines	Deal_Name Sub_Pipeline Stage	Single Line Picklist Picklist
Companies	Account_Name	Single Line
Products	Product_Name	Single Line
Tasks	Subject	Multi Line
Events	Event_Title Start_DateTime End_DateTime	Single Line Date/Time Date/Time
Calls	Call_Type Call_Duration Call_Start_Time	Picklist Single Line Date/Time

Fields in Bigin and their limitations

Below are the limitations for the fields in Bigin:

Fields	Field Type	Limitations
Single Line	string	Accepts up to 255 characters, as well as alphanumeric, and special characters.
Multi Line	string	Small - Accepts up to 2000 characters. Large - Accepts up to 32000 characters. Accepts alphanumeric and special characters. Cannot create custom views, reports, or filters.
Email	string	Accepts valid email IDs.
Phone	string	Accepts up to 30 characters. This limit may change based on the configuaration in Bigin UI. Only numeric characters and '+' (for extensions) allowed. Regex pattern to validate this field's value in Bigin: "[0-9a-zA-Z!#;%\\*\\^\$\$=\\{\\}\\[\\]\\?`~_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\\|\\\\\\s\\+]+"
Picklist	string	Can use existing or add new pick list value. Accepts alphanumeric and special characters.
Multi-select picklist	JSON array	Can use existing or add new pick list values. Accepts alphanumeric and special characters.
Date	string	Accepts date in yyyy-MM-dd format. Time zone is the current user's time zone.
Date/Time	string	Accepts date and time in yyyy-MM-ddTHH:mm:ss±HH:mm ISO8601 format.
Currency	double	Accepts only numeric values. Before decimal point - Accepts up to 16 digits. After decimal point - precision up to 9 digits. This limit may change based on the configuaration in Bigin UI.
Decimal	double	Accepts only numeric values. Before decimal point - Accepts up to 16 digits. After decimal point - Accepts precision up to 9 digits.
Percent	double	Accepts numbers up to 5 digits. Accepts only numeric values.
Long Integer	string	Accepts numbers up to 18 digits. Accepts only numeric values.
Checkbox	boolean	Accepts only Boolean values (true or false).
URL	string	Accepts valid URLs. Regex pattern to validate this field's value in Bigin: "^(http:\\/\\/www.\|https:\\/\\/www.\|ftp:\\/\\/www.\|www.\|http:\\/\\/\|https:\\/\\/\|ftp:\\/\\/\|){1}[^\\x00-\\x19\\x22-\\x27\\x2A-\\x2C\\x2E-\\x2F\\x3A-\\x40\\x5B-\\x5E\\x60\\x7B\\x7D-\\x7F]+(\\.[^\\x00-\\x19\\x22\\x24-\\x2C\\x2E-\\x2F\\x3C\\x3E\\x40\\x5B-\\x5E\\x60\\x7B\\x7D-\\x7F]+)+(\\/[^\\x00-\\x19\\x22\\x3C\\x3E\\x5E\\x7B\\x7D-\\x7D\\x7F])$"

Additionally, make sure to refer the Field Metadata API for accessing json_type and data_type of each field in a module.

Body parameters for adding contacts

Owner jsonobjectOptional

The ID of the owner to which the contact will be assigned. You can get the owner ID (or user ID) from the Get users data API.

Account_Name jsonobjectOptional

The ID of the company to which the contact will be associated. You can get the company ID from the Get records API.

First_Name stringOptional

Provide the first name of the contact.

Last_Name stringRequired

Provide the last name of the contact.

Title stringOptional

Provide a suitable title for the contact.

Email stringOptional

Provide the email address owned by the contact.

Mobile stringOptional

Provide the mobile number of the contact.

Email_Opt_Out booleanOptional

Provide whether the contact has opted out of receiving emails. The possible value can be true or false.

Tag jsonarrayOptional

Provide the list of tags that can be associated with the contact. You can get the list of tags from the Get all tags API.

Description stringOptional

Provide additional descriptions or notes related to the contact.

Mailing_Street, Mailing_City, Mailing_State, Mailing_Country, Mailing_Zip stringOptional

Provide the mailing address of the contact. The mailing address contains the following fields:

Mailing_Street - The street address of the contact.
Mailing_City - The city where the contact is located.
Mailing_State - The state or province where the contact is located.
Mailing_Country - The country of the contact.
Mailing_Zip - The ZIP or postal code of the contact.

Body parameters for adding pipelines

Owner jsonobjectOptional

The ID of the owner to which the pipeline record (deal) will be assigned. You can get the owner ID (or user ID) from the Get users data API.

Deal_Name stringRequired

Provide the name for the pipeline record (deal).

Account_Name jsonobjectOptional

The ID of the company to which the pipeline record (deal) will be associated. You can get the company ID from the Get records API.

Contact_Name jsonobjectOptional

The ID of the contact to which the pipeline record (deal) will be assigned. You can get the contact ID from the Get records API.

Sub_Pipeline stringRequired

Provide the name of the Sub-Pipeline to which the pipeline record (deal) belongs.

Stage stringRequired

Provide the current stage of the pipeline record (deal) within the Sub-Pipeline.

Amount doubleOptional

The amount of the pipeline record (deal).

Secondary_Contacts jsonarrayOptional

Provide a list of additional contacts associated with the pipeline record (deal).

Closing_Date dateOptional

Provide the expected or actual closing date of the pipeline record (deal).

Tag jsonarrayOptional

Provide the list of tags that can be associated with the pipeline record (deal). You can get the list of tags from the Get all tags API.

Pipeline stringOptional

Provide the name and ID of the Team Pipeline to which the pipeline record (deal) belongs. You can get the Team Pipeline ID from the Get layouts metadata API.

Associated_Products jsonarrayOptional

Provide the list of products in JSON format that need to be associated with the pipeline record (deal). You can get the product ID from the Get records API.

Body parameters for adding companies

Owner jsonobjectOptional

The ID of the owner to which the company record will be assigned. You can get the owner ID (or user ID) from the Get users data API.

Account_Name stringRequired

Provide the name of the company.

Phone stringOptional

Provide a phone number for the company.

Website stringOptional

Provide a website URL for the company.

Tag jsonarrayOptional

Provide the list of tags that can be associated with the company. You can get the list of tags from the Get all tags API.

Description stringOptional

Provide additional descriptions or notes related to the company.

Billing_Street, Billing_City, Billing_State, Billing_Country, Billing_Code stringOptional

Provide the billing address of the company. The billing address contains the following fields:

Billing_Street - The street address of the company.
Billing_City - The city where the company is located.
Billing_State - The state or province where the company is located.
Billing_Country - The country of the company.
Billing_code - The ZIP or postal code of the company.

Body parameters for adding products

Owner jsonobjectOptional

The ID of the owner to which the product record will be assigned. You can get the owner ID (or user ID) from the Get users data API.

Product_Name stringRequired

Provide the name of the product being added.

Product_Code stringOptional

Provide a unique code or identifier for the product.

Unit_Price doubleOptional

Provide the unit price or cost of the product.

Product_Category stringOptional

Provide the type or category of the product.

Description stringOptional

Provide additional descriptions or notes related to the product.

Tag jsonarrayOptional

Provide the list of tags that can be associated with the product. You can get the list of tags from the Get all tags API.

Product_Active booleanOptional

Provide whether the product is currently active or not. The possible value can be true or false.

Body parameters for adding call records

Owner jsonobjectOptional

The ID of the owner to which the call record will be assigned. You can get the owner ID (or user ID) from the Get users data API.

Contact_Name stringOptional

The ID of the contact to which the call record is associated. You an get the contact ID from the Get records API.

Call_Start_Time stringRequired

Provide the start time of the call in the ISO8601 format.

Call_Duration doubleRequired

Provide the duration of the call in minutes.

Call_Type stringRequired

Provide the type of the call. The possible values are Outbound, Inbound or Missed.

Related_To stringOptional

Provide the details about the entities the call is related.

Subject jsonarrayOptional

Provide a subject or topic associated with the call.

Description booleanOptional

Provide additional descriptions or notes related to the task.

Call_Agenda booleanOptional

Provide the details about the agenda or specific purpose for the call.

Reminder booleanOptional

Provide the reminder data and time (ISO8601) to notify or prompt before the call starts.

Dialled_Number booleanOptional

Provide the number dialed for the call.

Tag booleanOptional

Provide the list of tags that can be associated with the event. You can get the list of tags from the Get all tags API.

Body parameters for adding events

Owner jsonobjectOptional

The ID of the owner to which the event record will be assigned. You can get the owner ID (or user ID) from the Get users data API.

Event_Title stringRequired

Provide the title or name of the event.

Start_DateTime datetimeRequired

Provide the start date and time (ISO8601) of the event.

End_DateTime datetimeRequired

Provide the end date and time (ISO8601) of the event.

All_day booleanOptional

Provide whether the event is an all-day event. The possible value can be true or false.

Recurring_Activity jsonobjectOptional

Contains the details about the recurrence pattern of the event in the key RRULE. For example, RRULE = "FREQ=MONTHLY;INTERVAL=1;BYDAY=MO;UNTIL=2023-09-05"

In the RRULE key, the following are the mandatory values:

FREQ - Indicates how often the event repeats. The possible values are DAILY, WEEKLY, MONTHLY, or YEARLY.
INTERVAL - Indicates the time gap between each event. The INTERVAL value range from 1 to 99. For example, an INTERVAL of 2 for a WEEKLY recurring event means that there will be a two-week gap between each event.
COUNT - Indicates the number of events you want to create. THE COUNT value range from 1 to 99. For example, a COUNT of 3 creates three individual events.

In the RRULE key, the following are the optional values:

BYMONTHDAY - Indicates the day of the month the event repeats. The BYMONTHDAY value range from 1 to 31. This is applicable only for monthly and yearly events.
BYDAY - Indicates the day of the week the event repeats. The possible values are SU, MO, TU, WE, TH, FR, or SA. This is applicable only for daily, weekly, monthly, and yearly events.
BYSETPOS - Indicates the week of the month the event repeats. The possible values are 1 for the first week of the month, 2 for the second week of the month, 3 the for third week of the month, 4 for the fourth week of the month, or -1 for the last week of the month. This is applicable only for monthly and yearly events.
UNTIL - Indicates the end date of the event repetition. Provide date in YYYY-MM-DD format.

Remind_At jsonarrayOptional

Provide the reminder list to notify or prompt participants before the event. Set this using time unit values such as unit and period.

Venue stringOptional

Provide the location or venue of the event.

Related_To jsonobjectOptional

Provide the details about the entities the event is related.

Participants jsonarrayOptional

Provide a list of participants or attendees associated with the event.

Description stringOptional

Provide additional descriptions or notes related to the event.

Tag jsonarrayOptional

Provide the list of tags that can be associated with the event. You can get the list of tags from the Get all tags API.

Body parameters for adding tasks

Owner jsonobjectOptional

The ID of the owner to which the task record will be assigned. You can get the owner ID (or user ID) from the Get users data API.

Subject stringRequired

Provide the subject or title of the task.

Due_Date stringOptional

Provide the due date of the task.

Recurring_Activity jsonobjectOptional

Contains the details about the recurrence pattern of the event in the key RRULE. For example, RRULE = "FREQ=MONTHLY;INTERVAL=1;BYDAY=MO;UNTIL=2023-09-05"

In the RRULE key, the following are the mandatory values:

FREQ - Indicates how often the event repeats. The possible values are DAILY, WEEKLY, MONTHLY, or YEARLY.
INTERVAL - Indicates the time gap between each event. The INTERVAL value range from 1 to 99. For example, an INTERVAL of 2 for a WEEKLY recurring event means that there will be a two-week gap between each event.
COUNT - Indicates the number of events you want to create. THE COUNT value range from 1 to 99. For example, a COUNT of 3 creates three individual events.

In the RRULE key, the following are the optional values:

BYMONTHDAY - Indicates the day of the month the event repeats. The BYMONTHDAY value range from 1 to 31. This is applicable only for monthly and yearly events.
BYDAY - Indicates the day of the week the event repeats. The possible values are SU, MO, TU, WE, TH, FR, or SA. This is applicable only for daily, weekly, monthly, and yearly events.
BYSETPOS - Indicates the week of the month the event repeats. The possible values are 1 for the first week of the month, 2 for the second week of the month, 3 the for third week of the month, 4 for the fourth week of the month, or -1 for the last week of the month. This is applicable only for monthly and yearly events.
UNTIL - Indicates the end date of the event repetition. Provide date in YYYY-MM-DD format.

Remind_At jsonobjectOptional

Provide the reminder to notify or prompt members associated with the task in the key ALARM.

Examples:

For recurring tasks, "ALARM" : "ACTION=EMAIL;TRIGGER=P1D;TRIGGER_TIME=22:45"
For non-recurring tasks, "ALARM" : "ACTION=EMAIL;TRIGGER=DATE-TIME:2023-07-25T12:00:00+05:30"

In the ALARM key, provide the following details:

ACTION Required

Indicates the way the reminder should be shown for a task. It can be shown as an email or a pop-up. The values include EMAIL or POPUP.

TRIGGER Required

Indicates when the task should be triggered.

For recurring tasks, use -PnD and -PmD to trigger the reminder before 'n' days or 'm' weeks. For example, if you want to trigger a reminder 2 days before the task, use -P2D. Similarly, if you want to trigger a reminder 3 weeks before the task, use -P3W.
For non-recurring tasks, use DATE-TIME followed by the date and time value in ISO8601 format. This will trigger the reminder at the specified date and time. For example, TRIGGER = DATE-TIME:2023-07-25T12:00:00+05:30

TRIGGER_TIME Required for Recurring Tasks only

Indicates the time in 24-hour format, which can only be used for recurring tasks with -PnD and -PmW as a trigger.

Related_To jsonobjectOptional

Provide the details about the entities the task is related.

Description stringOptional

Provide additional descriptions or notes related to the task.

Priority stringOptional

Provide the priority level of the task.

Status stringOptional

Provide the current status of the task.

Tag jsonarrayOptional

Provide the list of tags that can be associated with the event. You can get the list of tags from the Get all tags API.

Sample request

Copiedcurl "https://www.zohoapis.com/bigin/v2/Contacts" \
-X POST \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" \
-d "@newcontact.json"

Copiednew_contact = Map();

Sample request body - Contacts

Copied//Consider the following data is saved in a file 'newcontact.json'
{
	"data": [
		{
			"Owner": {
				"id": "2034020000000457001"
			},
			"Account_Name": {
				"id": "2034020000000489159"
			},
			"First_Name": "Sarah",
			"Last_Name": "Johnson",
			"Title": "HR Director",
			"Email": "sarah.johnson@example.com",
			"Mobile": "+1 (555) 987-6543",
			"Email_Opt_Out": true,
			"Tag": [
				{
					"name": "Recruitment"
				}
			],
			"Description": "Manages all aspects of human resources and recruitment processes.",
			"Mailing_Street": "456 Elm Avenue",
			"Mailing_City": "Springfield",
			"Mailing_State": "Illinois",
			"Mailing_Country": "United States",
			"Mailing_Zip": "67890"
		},
		{
			"Owner": {
				"id": "2034020000000457001"
			},
			"Account_Name": {
				"id": "2034020000000489159"
			},
			"First_Name": "Robert",
			"Last_Name": "Williams",
			"Title": "Manager",
			"Email": "robert.williams@example.com",
			"Mobile": "+1 (555) 246-8135",
			"Email_Opt_Out": false,
			"Tag": [],
			"Description": "Manager responsible for overall team strategy and decision-making.",
			"Mailing_Street": "789 Oak Lane",
			"Mailing_City": "Metropolis",
			"Mailing_State": "New York",
			"Mailing_Country": "United States",
			"Mailing_Zip": "54321"
		}
	]
}

Copiednew_contact = Map();

Sample request body - Pipelines

Copied//Consider the following data is saved in a file 'newpipeline.json'
{
    "data": [
        {
            "Owner": {
                "id": "2034020000000457001"
            },
            "Deal_Name": "Adventure Tour Package",
            "Account_Name": {
                "id": "2034020000000459518"
            },
            "Contact_Name": {
                "id": "2034020000000489033"
            },
            "Sub_Pipeline": "Sales Pipeline Standard",
            "Stage": "Needs Analysis",
            "Amount": "4000",
            "Secondary_Contacts": [],
            "Closing_Date": "2023-10-10",
            "Tag": [
                {
                    "name": "Adventure"
                },
                {
                    "name": "SuperCool"
                }
            ],
            "Description": "A sample pipeline record",
            "Pipeline": {
                "name": "Sales - Marketing",
                "id": "2034020000000095023"
            },
            "Associated_Products": [
		{
			"Product": {
				"name": "Amazon Rainforest Expedition",
				"id": "2034020000000489203"
			},
			"List_Price": 2000,
			"Quantity": 1,
			"Discount": 0
		},
		{
			"Product": {
				"name": "African Safari Adventure",
				"id": "2034020000000489200"
			},
			"List_Price": 1500,
			"Quantity": 2,
			"Discount": 10
		}
            ]
        }
    ]
}

Copiednew_contact = Map();

Sample request body - Companies

Copied//Consider the following data is saved in a file 'newcompany.json'
{
	"data": [
		{
			"Owner": {
				"id": "2034020000000457001"
			},
			"Account_Name": "Techtronics Inc.",
			"Phone": "+1-555-1234567",
			"Website": "www.techtronics.com",
			"Tag": [
				{
					"name"= "Tech"
				},
				{
					"name"= "Gadgets"
				}
			],
			"Description": "Techtronics Inc. is a leading provider of innovative electronic gadgets and cutting-edge technology solutions.",
			"Billing_Street": "123 Main Street",
			"Billing_City": "Anytown",
			"Billing_State": "California",
			"Billing_Country": "United States",
			"Billing_Code": "12345"
		}
	]
}

Copiednew_contact = Map();

Sample request body - Products

Copied//Consider the following data is saved in a file 'newproduct.json'
{
	"data":[
		{
			"Owner": {
				"id": "2034020000000457001"
			},
			"Product_Name": "Adventure Safari",
			"Product_Code": "ADV001",
			"Unit_Price": 500,
			"Product_Category": "Safari",
			"Description": "Embark on an exhilarating adventure with our Adventure Safari package. This 7-day tour takes you deep into the heart of the African wilderness, where you'll encounter breathtaking landscapes and observe majestic wildlife up close. Our experienced guides will lead you on thrilling game drives, bush walks, and boat safaris, ensuring an unforgettable journey through nature's wonders.",
			"Tag": [
				{
					"name": "Wildlife"
				},
				{
					"name": "Adventure"
				}
			],
			"Product_Active": true
		}
	]
}

Copiednew_contact = Map();

Sample request body - Calls

Copied//Consider the following data is saved in a file 'newcall.json'
{
	"data":[
		{
			"Owner": {
				"id": "2034020000000457001"
			},
			"Contact_Name": {
				"id": "2034020000000489033"
			},
			"Call_Start_Time": "2023-07-12T15:30:00+05:30",
			"Call_Duration": "90:00",
			"Call_Type": "Outbound",
			"Related_To": {
				"name": "Cruise Package",
                "id": "2034020000000489123"
			},
			"Subject": "Cruise Package Discussion",
			"Description": "This is sample call about cruise package discussion",
			"Call_Agenda": "Discuss requirements and prices of the package.",
			"Reminder": ""2023-07-12T15:25:00+05:30"",
			"Dialled_Number": "+1 (555) 246-8135",
			"Tag": [
				{
					"name": "Vacation"
				},
				{
					"name": "Adventure"
				}
			]
		}
	]
}

Copiednew_contact = Map();

Sample request body - Events

Copied//Consider the following data is saved in a file 'newevent.json'
{
	"data": [
		{
			"Owner": {
				"id": "2034020000000457001"
			},
			"Event_Title": "Event before SKI Vacation Package",
			"Start_DateTime": "2023-08-20T10:00:00+05:30",
			"End_DateTime": "2023-08-21T10:00:00+05:30",
			"All_day": false,
			"$se_module": "Contacts",
			"Recurring_Activity": {
				"RRULE":"FREQ=MONTHLY;INTERVAL=1;BYDAY=MO;UNTIL=2023-09-05"
			},
			"Remind_At":  [
				{
					"unit": 1,
					"period": "hours"
				},
				{
					"unit": 30,
					"period": "minutes"
				}
			],
			"Venue": "Online (Zoom)",
			"Related_To": {
				"name": "Ski Vacation Package Closed Lost",
				"id": "2034020000000478422"
			},
			"Participants": [
				{
					"type": "user",
					"participant": "2034020000000472114"
				},
				{
					"type": "email",
					"participant": "aravind.vavilala+bigin_v2apis@zohotest.com"
				},
				{
					"type": "contact",
					"participant": "2034020000000489034"
				}
			],
			"Description": "This is a sample event on the SKI Vacation Package.",
			"Tag": [
				{
					"name": "Remote"
				},
				{
					"name": "Vacation"
				}
			]
		}
	]
}

Copiednew_contact = Map();

Sample request body - Tasks

Copied//Consider the following data is saved in a file 'newtask.json'
{
    "data": [
        {
            "Owner": {
                "id": "2034020000000457001"
            },
            "Subject": "Follow-up email to Ava Bell",
            "Due_Date": "2023-07-25",
            "Recurring_Activity": {
                "RRULE": "FREQ=WEEKLY;INTERVAL=1;UNTIL=2023-07-27;BYDAY=TH;DTSTART=2023-07-26"
            },
            "Remind_At": {
                "ALARM": "FREQ=NONE;ACTION=EMAIL;TRIGGER=DATE-TIME:2023-07-25T12:00:00+05:30"
            },
            "Related_To": {
                "name": "Wellness Retreat Package",
                "id": "2034020000000489080"
            },
            "Description": "This task is related to contacting Ava Bell regarding Wellness Retreat Package.",
            "Priority": "Normal",
            "Status": "Not Started",
            "Tag": []
        }
    ]
}

Copiednew_contact = Map();

Response object

The response object provides information regarding the success message or status.

Possible error codes

The response of this resource includes HTTP status and error codes.

The most common HTTP error codes that occur when you request access to this endpoint are given in the following:

INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.
INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.
NO_PERMISSION 403
Permission denied to create '{modulename}'
Resolution:No permission to insert records.
MANDATORY_NOT_FOUNDHTTP 400
Required field not found
Resolution: Required field not found. If the data key isn't available { "api_name": "data" }
INVALID_DATAHTTP 202
Invalid Data
Resolution: If the record passed isn't a JSON object { "expected_data_type":"jsonobject", "index": 0 }
MANDATORY_NOT_FOUNDHTTP 202
Required field not found
Resolution: If the mandatory fields are not available { "api_name":"Last_Name" }
INVALID_DATAHTTP 202
Invalid Data
Resolution: If the data type is mismatched { "expected_data_type":"double", "api_name":"Decimal_1" }
INVALID_DATAHTTP 400
Invalid Data
Resolution: If the data key has the invalid data type { "expected_data_type":"jsonarray", "api_name": "data" },

Sample Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-06-27T13:14:19+05:30",
                "Modified_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "Created_Time": "2023-06-27T13:14:19+05:30",
                "id": "2034020000000644029",
                "Created_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "$approval_state": "approved"
            },
            "message": "record added",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-06-27T13:14:19+05:30",
                "Modified_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "Created_Time": "2023-06-27T13:14:19+05:30",
                "id": "2034020000000644034",
                "Created_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "$approval_state": "approved"
            },
            "message": "record added",
            "status": "success"
        }
    ]
}