Add notes

Add new notes to multiple records or a specific record.

Endpoints

POST /Notes

POST /{module_api_name}/{record_id}/Notes

Request URL

For multiple records, use

{api-domain}/bigin/v2/Notes

For a specific record, use

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

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 and ZohoBigin.modules.notes.ALL
ZohoBigin.modules.ALL and ZohoBigin.modules.notes.WRITE
ZohoBigin.modules.ALL and ZohoBigin.modules.notes.CREATE
ZohoBigin.modules.{module_name}.ALL and ZohoBigin.modules.notes.ALL
ZohoBigin.modules.{module_name}.ALL and ZohoBigin.modules.notes.WRITE
ZohoBigin.modules.{module_name}.ALL and ZohoBigin.modules.notes.CREATE
ZohoBigin.modules.{module_name}.WRITE and ZohoBigin.modules.notes.ALL
ZohoBigin.modules.{module_name}.WRITE and ZohoBigin.modules.notes.WRITE
ZohoBigin.modules.{module_name}.WRITE and ZohoBigin.modules.notes.CREATE
ZohoBigin.modules.{module_name}.CREATE and ZohoBigin.modules.notes.ALL
ZohoBigin.modules.{module_name}.CREATE and ZohoBigin.modules.notes.WRITE
ZohoBigin.modules.{module_name}.CREATE and ZohoBigin.modules.notes.CREATE

In the above scope, replace {module_name} with the module for which you want to retrieve the records. The possible modules include pipelines, contacts, accounts (companies in Bigin), products, calls, events, and tasks.

Request parameters

The available request parameters are given below:

Path parameters

The following path parameters are used to add notes to a specific record:

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

record_id stringRequired

The unique identification of a record in a module. You can get the record ID from the Get records API.

Body parameters

Note_Title stringOptional

Provide the title for the note.

Note_Content stringRequired

Provide the content for the note.

Parent_Id stringRequired

Provide the ID of the parent record. You can get the record IDs from the Get records API.

se_module stringRequired

Provide the API name of the module to which the note belongs. You can get the module API names from the Get all modules API.

Note: 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.

Sample request - add notes to multiple records

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

Copiednote1 = Map();
note1.put("Note_Title", "Contacted");
note1.put("Note_Content", "Need to do further tracking");
note1.put("Parent_Id", "692969000000981055");
note1.put("se_module", "Contacts");

dataList = List();
dataList.add(note1);

params = Map();
params.put("data", dataList);

response = invokeurl
[
	url :"https://www.zohoapis.com/bigin/v1/Notes"
	type :POST
	parameters: params.toString()
	connection:"bigin_oauth_connection"
];
info response;

Sample request body

Copied//Consider the following data is saved in a file 'newnotes.json'
{
    "data": [
        {
            "Note_Title": "Safari destination",
            "Note_Content": "Serengeti National Park, Tanzania.",
            "Parent_Id": "2034020000000478276",
            "se_module": "Pipelines"
        },
        {
            "Note_Content": "Special request for a knowledgeable wildlife guide.",
            "Parent_Id": "2034020000000478276",
            "se_module": "Pipelines"
        },
        {
            "Note_Title": "Target audience",
            "Note_Content": "Adventure enthusiasts aged 18-35.",
            "Parent_Id": "2034020000000478392",
            "se_module": "Pipelines"
        }
    ]
}

Copiednote1 = Map();
note1.put("Note_Title", "Contacted");
note1.put("Note_Content", "Need to do further tracking");
note1.put("Parent_Id", "692969000000981055");
note1.put("se_module", "Contacts");

dataList = List();
dataList.add(note1);

params = Map();
params.put("data", dataList);

response = invokeurl
[
	url :"https://www.zohoapis.com/bigin/v1/Notes"
	type :POST
	parameters: params.toString()
	connection:"bigin_oauth_connection"
];
info response;

Sample request - add notes to a specific record

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

Copiednote1 = Map();
note1.put("Note_Title", "Contacted");
note1.put("Note_Content", "Need to do further tracking");
note1.put("Parent_Id", "692969000000981055");
note1.put("se_module", "Contacts");

dataList = List();
dataList.add(note1);

params = Map();
params.put("data", dataList);

response = invokeurl
[
	url :"https://www.zohoapis.com/bigin/v1/Notes"
	type :POST
	parameters: params.toString()
	connection:"bigin_oauth_connection"
];
info response;

Sample request body

Copied//Consider the following data is saved in a file 'newnote.json'
{
	"data":[
		{
			"Note_Title": "Preferred campaign duration",
			"Note_Content": "3 weeks, starting from 1st October 2023."
		}
    ]
}

Copiednote1 = Map();
note1.put("Note_Title", "Contacted");
note1.put("Note_Content", "Need to do further tracking");
note1.put("Parent_Id", "692969000000981055");
note1.put("se_module", "Contacts");

dataList = List();
dataList.add(note1);

params = Map();
params.put("data", dataList);

response = invokeurl
[
	url :"https://www.zohoapis.com/bigin/v1/Notes"
	type :POST
	parameters: params.toString()
	connection:"bigin_oauth_connection"
];
info response;

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.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoBigin.modules.notes.CREATE scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to add notes details
Resolution: The user does not have permission to add notes data. Contact your system administrator.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.
INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.
AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to add notes
Resolution: The user does not have the permission to add notes data. Contact your system administrator.
INVALID_DATAHTTP 400
the related id given seems to be invalid
Resolution: You have specified an incorrect related record ID. Please specify a valid record ID. Refer to Get Related Records API to get valid record IDs.
MANDATORY_NOT_FOUNDHTTP 202
required field not found
Resolution: You have not specified one or more mandatory fields in the input. Refer to Fields Metadata API to know the mandatory fields.

Sample response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-07-23T01:06:48+05:30",
                "Modified_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "Created_Time": "2023-07-23T01:06:48+05:30",
                "id": "2034020000000723028",
                "Created_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                }
            },
            "message": "record added",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-07-23T01:06:48+05:30",
                "Modified_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "Created_Time": "2023-07-23T01:06:48+05:30",
                "id": "2034020000000723029",
                "Created_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                }
            },
            "message": "record added",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-07-23T01:06:48+05:30",
                "Modified_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "Created_Time": "2023-07-23T01:06:48+05:30",
                "id": "2034020000000723030",
                "Created_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                }
            },
            "message": "record added",
            "status": "success"
        }
    ]
}