Bigin by Zoho CRM

App · 24 actions

Run Bigin, Zoho's CRM for small teams, from workflows: keep contacts, companies and products, move records through pipeline stages, and log tasks, events, calls and notes.

Actions

ActionWhat it does
Add noteAdd a note to a record.
Create companyAdd a company.
Create contactAdd a contact.
Create eventAdd an event (a meeting) with a start and an end, optionally about a contact, company or pipeline record.
Create pipeline recordAdd a record to a pipeline (a deal).
Create productAdd a product.
Create taskAdd a task, optionally about a contact, company or pipeline record.
Delete noteDelete a note by its id.
Delete recordDelete one record.
Get recordGet one record of any type by its id.
List fieldsList a record type's fields with their API names, types and pick list values, to find the names that 'Other fields' and 'Fields to return' need.
List notesList the notes on one record.
List pipelinesList the account's pipelines with their sub-pipelines and each sub-pipeline's stages.
List recordsList the records of one type, newest first unless sorted otherwise.
List usersList the account's users and their ids, for use as record owners.
Log callRecord a call that was made, received or missed, with when it started and how long it lasted.
Search recordsFind records by email, phone, any word, or a criteria expression.
Update companyChange a company.
Update contactChange a contact.
Update eventChange an event.
Update noteChange a note's title or text.
Update pipeline recordChange a pipeline record, for instance to move it to another stage.
Update productChange a product.
Update taskChange a task, for instance to mark it completed.

Add note

Add a note to a record.

Inputs

Record typemoduletextRequired
What kind of record.One of: Contacts, Accounts (Companies), Pipelines (Pipelines (deals)), Products, Tasks, Events, Calls.
Record IDrecord_idtextRequired
The record's id, from 'List records' or an earlier step, or a Bigin address ending in it.
NotecontenttextRequired
The note's text.
Titletitletext
The note's title.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record added",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Create company

Add a company. Only the name is required. The result holds the new company's id.

Inputs

Company namecompany_nametextRequired
The company's name.
Phonephonetext
The company's phone number.
Websitewebsitetext
The company's website.
Descriptiondescriptiontext
Free text kept on the record.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record added",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Create contact

Add a contact. Only the last name is required. The result holds the new contact's id.

Inputs

Last namelast_nametextRequired
The contact's last name.
First namefirst_nametext
The contact's first name.
Emailemailtext
The contact's email address.
Mobilemobiletext
The contact's mobile number.
Phonephonetext
The contact's phone number.
Titletitletext
The contact's job title.
Company IDcompany_idtext
The id of the company the contact works for.
Descriptiondescriptiontext
Free text kept on the record.
Email opt outemail_opt_outtrue/false
Turn on if the contact asked not to get emails.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record added",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Create event

Add an event (a meeting) with a start and an end, optionally about a contact, company or pipeline record.

Inputs

TitletitletextRequired
The event's title.
Startsstart_timedate and timeRequired
When the event starts.
Endsend_timedate and timeRequired
When the event ends, after the start.
All dayall_daytrue/false
Turn on for an all-day event.
Venuevenuetext
Where it takes place.
Descriptiondescriptiontext
Free text kept on the record.
Related torelated_moduletext
What kind of record this is about. Choose it together with the record id.One of: Contacts (Contact), Accounts (Company), Deals (Pipeline record (deal)).
Related record IDrelated_record_idtext
The id of the record this is about.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record added",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Create pipeline record

Add a record to a pipeline (a deal). It needs a sub-pipeline and one of that sub-pipeline's stages.

Inputs

Namedeal_nametextRequired
The pipeline record's name.
Sub-pipelinesub_pipelinetextRequired
The sub-pipeline the record belongs to.
StagestagetextRequired
The stage, one that belongs to the sub-pipeline.
Amountamountnumber
The value of the record.At least 0.
Closing dateclosing_datedate
When it is expected to close.
Company IDcompany_idtext
The id of the company it is for.
Contact IDcontact_idtext
The id of the contact it is for.
Team pipelinepipeline_idtext
The team pipeline, if your account has more than one.
Descriptiondescriptiontext
Free text kept on the record.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record added",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Create product

Add a product. Only the name is required.

Inputs

Product nameproduct_nametextRequired
The product's name.
Product codeproduct_codetext
The product's code or SKU.
Unit priceunit_pricenumber
The price of one.At least 0.
Activeactivetrue/false
Whether the product can be sold.
Descriptiondescriptiontext
Free text kept on the record.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record added",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Create task

Add a task, optionally about a contact, company or pipeline record.

Inputs

SubjectsubjecttextRequired
What the task is.
Due datedue_datedate
When the task is due.
Statusstatustext
The task's status, from your account's list.
Priorityprioritytext
The task's priority, from your account's list.
Descriptiondescriptiontext
Free text kept on the record.
Related torelated_moduletext
What kind of record this is about. Choose it together with the record id.One of: Contacts (Contact), Accounts (Company), Deals (Pipeline record (deal)).
Related record IDrelated_record_idtext
The id of the record this is about.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record added",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Delete note

Delete a note by its id.

Inputs

Note IDnote_idtextRequired
The note's id, from 'List notes' or an earlier step.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record deleted",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Delete record

Delete one record. Bigin moves it to the recycle bin, where it can be restored.

Inputs

Record typemoduletextRequired
What kind of record.One of: Contacts, Accounts (Companies), Pipelines (Pipelines (deals)), Products, Tasks, Events, Calls.
Record IDrecord_idtextRequired
The record's id, from 'List records' or an earlier step, or a Bigin address ending in it.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record deleted",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Get record

Get one record of any type by its id. A read by id sees a record the moment it is created, unlike search.

Inputs

Record typemoduletextRequired
What kind of record.One of: Contacts, Accounts (Companies), Pipelines (Pipelines (deals)), Products, Tasks, Events, Calls.
Record IDrecord_idtextRequired
The record's id, from 'List records' or an earlier step, or a Bigin address ending in it.
Fields to returnfieldstext
Field API names separated by commas, up to 50. Leave empty for the usual ones. Find the names with 'List fields'.

Outputs

recordobject
A Bigin record. Only the fields of its module are present, and any other field the account has comes back too
Example output
{
  "record": {
    "Account_Name": {
      "id": "2034020000000489001",
      "name": "Northwind Traders"
    },
    "All_day": false,
    "Amount": 0,
    "Call_Duration": "",
    "Call_Start_Time": "",
    "Call_Status": "",
    "Call_Type": "",
    "Closing_Date": "",
    "Contact_Name": {
      "id": "",
      "name": ""
    },
    "Created_Time": "2026-10-01T10:20:00+05:30",
    "Deal_Name": "",
    "Description": "",
    "Due_Date": "",
    "Email": "james.bennett@example.com",
    "End_DateTime": "",
    "Event_Title": "",
    "First_Name": "James",
    "Full_Name": "James Bennett",
    "Last_Name": "Bennett",
    "Mobile": "+15555550100",
    "Modified_Time": "2026-10-02T09:00:00+05:30",
    "Owner": {
      "email": "dana@example.com",
      "id": "2034020000000312001",
      "name": "Dana Reed"
    },
    "Phone": "",
    "Pipeline": {
      "id": "",
      "name": ""
    },
    "Priority": "",
    "Product_Active": false,
    "Product_Category": "",
    "Product_Code": "",
    "Product_Name": "",
    "Stage": "",
    "Start_DateTime": "",
    "Status": "",
    "Sub_Pipeline": "",
    "Subject": "",
    "Title": "Buyer",
    "Unit_Price": 0,
    "Venue": "",
    "Website": "",
    "id": "2034020000000489034"
  }
}

List fields

List a record type's fields with their API names, types and pick list values, to find the names that 'Other fields' and 'Fields to return' need.

Inputs

Record typemoduletextRequired
What kind of record.One of: Contacts, Accounts (Companies), Pipelines (Pipelines (deals)), Products, Tasks, Events, Calls.

Outputs

countnumber
How many fields
fieldslist
The fields
moduletext
The record type
Example output
{
  "count": 1,
  "fields": [
    {
      "api_name": "Last_Name",
      "custom": false,
      "data_type": "text",
      "label": "Last Name",
      "read_only": false,
      "required": true,
      "values": []
    }
  ],
  "module": "Contacts"
}

List notes

List the notes on one record.

Inputs

Record typemoduletextRequired
What kind of record.One of: Contacts, Accounts (Companies), Pipelines (Pipelines (deals)), Products, Tasks, Events, Calls.
Record IDrecord_idtextRequired
The record's id, from 'List records' or an earlier step, or a Bigin address ending in it.
Records per pagelimitnumber
How many to return, 1 to 200. Defaults to 20.From 1 to 200.
Pagepagenumber
Which page to return, 1 to 10 (the first 2,000 records). Defaults to 1.From 1 to 10.

Outputs

countnumber
How many came back on this page
more_recordstrue/false
Whether another page follows
next_page_tokentext
Token for reading past 2,000 records, empty if none
noteslist
The notes
pagenumber
The page number
per_pagenumber
The page size used
Example output
{
  "count": 1,
  "more_records": false,
  "next_page_token": "",
  "notes": [
    {
      "Created_Time": "2026-10-03T10:20:00+05:30",
      "Modified_Time": "2026-10-03T10:20:00+05:30",
      "Note_Content": "Asked for a quote.",
      "Note_Title": "Call summary",
      "Owner": {
        "email": "dana@example.com",
        "id": "2034020000000312001",
        "name": "Dana Reed"
      },
      "Parent_Id": {
        "id": "2034020000000489034",
        "name": "James Bennett"
      },
      "id": "2034020000000490001"
    }
  ],
  "page": 1,
  "per_page": 20
}

List pipelines

List the account's pipelines with their sub-pipelines and each sub-pipeline's stages.

Inputs

None.

Outputs

countnumber
How many pipelines
pipelineslist
The pipelines
Example output
{
  "count": 1,
  "pipelines": [
    {
      "id": "2034020000000095023",
      "name": "Sales",
      "status": "active",
      "sub_pipelines": [
        {
          "name": "Sales Pipeline Standard",
          "stages": [
            "Qualification",
            "Proposal",
            "Closed Won"
          ]
        }
      ]
    }
  ]
}

List records

List the records of one type, newest first unless sorted otherwise. Returns one page; use 'Page' for more.

Inputs

Record typemoduletextRequired
What kind of record.One of: Contacts, Accounts (Companies), Pipelines (Pipelines (deals)), Products, Tasks, Events, Calls.
Records per pagelimitnumber
How many to return, 1 to 200. Defaults to 20.From 1 to 200.
Pagepagenumber
Which page to return, 1 to 10 (the first 2,000 records). Defaults to 1.From 1 to 10.
Sort bysort_bytext
What to sort by. Defaults to date created.One of: Created_Time (Date created), Modified_Time (Date modified), id.
Sort ordersort_ordertext
Defaults to newest first.One of: desc (Newest or highest first), asc (Oldest or lowest first).
Fields to returnfieldstext
Field API names separated by commas, up to 50. Leave empty for the usual ones. Find the names with 'List fields'.

Outputs

countnumber
How many came back on this page
more_recordstrue/false
Whether another page follows
next_page_tokentext
Token for reading past 2,000 records, empty if none
pagenumber
The page number
per_pagenumber
The page size used
recordslist
The records
Example output
{
  "count": 2,
  "more_records": false,
  "next_page_token": "",
  "page": 1,
  "per_page": 20,
  "records": [
    {
      "Account_Name": {
        "id": "2034020000000489001",
        "name": "Northwind Traders"
      },
      "All_day": false,
      "Amount": 0,
      "Call_Duration": "",
      "Call_Start_Time": "",
      "Call_Status": "",
      "Call_Type": "",
      "Closing_Date": "",
      "Contact_Name": {
        "id": "",
        "name": ""
      },
      "Created_Time": "2026-10-01T10:20:00+05:30",
      "Deal_Name": "",
      "Description": "",
      "Due_Date": "",
      "Email": "james.bennett@example.com",
      "End_DateTime": "",
      "Event_Title": "",
      "First_Name": "James",
      "Full_Name": "James Bennett",
      "Last_Name": "Bennett",
      "Mobile": "+15555550100",
      "Modified_Time": "2026-10-02T09:00:00+05:30",
      "Owner": {
        "email": "dana@example.com",
        "id": "2034020000000312001",
        "name": "Dana Reed"
      },
      "Phone": "",
      "Pipeline": {
        "id": "",
        "name": ""
      },
      "Priority": "",
      "Product_Active": false,
      "Product_Category": "",
      "Product_Code": "",
      "Product_Name": "",
      "Stage": "",
      "Start_DateTime": "",
      "Status": "",
      "Sub_Pipeline": "",
      "Subject": "",
      "Title": "Buyer",
      "Unit_Price": 0,
      "Venue": "",
      "Website": "",
      "id": "2034020000000489034"
    },
    {
      "Account_Name": "",
      "All_day": false,
      "Amount": 2500,
      "Call_Duration": "",
      "Call_Start_Time": "",
      "Call_Status": "",
      "Call_Type": "",
      "Closing_Date": "2026-12-31",
      "Contact_Name": {
        "id": "",
        "name": ""
      },
      "Created_Time": "2026-10-01T10:20:00+05:30",
      "Deal_Name": "Spring order",
      "Description": "",
      "Due_Date": "",
      "Email": "",
      "End_DateTime": "",
      "Event_Title": "",
      "First_Name": "",
      "Full_Name": "",
      "Last_Name": "",
      "Mobile": "",
      "Modified_Time": "2026-10-02T09:00:00+05:30",
      "Owner": {
        "email": "dana@example.com",
        "id": "2034020000000312001",
        "name": "Dana Reed"
      },
      "Phone": "",
      "Pipeline": {
        "id": "",
        "name": ""
      },
      "Priority": "",
      "Product_Active": false,
      "Product_Category": "",
      "Product_Code": "",
      "Product_Name": "",
      "Stage": "Qualification",
      "Start_DateTime": "",
      "Status": "",
      "Sub_Pipeline": "Sales Pipeline Standard",
      "Subject": "",
      "Title": "",
      "Unit_Price": 0,
      "Venue": "",
      "Website": "",
      "id": "2034020000000489100"
    }
  ]
}

List users

List the account's users and their ids, for use as record owners.

Inputs

Which usersuser_typetext
Defaults to active users.One of: ActiveUsers (Active users), AllUsers (All users), DeactiveUsers (Inactive users), AdminUsers (Admins), CurrentUser (The connected user only).

Outputs

countnumber
How many users
userslist
The users
Example output
{
  "count": 1,
  "users": [
    {
      "email": "dana@example.com",
      "full_name": "Dana Reed",
      "id": "2034020000000312001",
      "profile": {
        "id": "2",
        "name": "Administrator"
      },
      "role": {
        "id": "1",
        "name": "CEO"
      },
      "status": "active"
    }
  ]
}

Log call

Record a call that was made, received or missed, with when it started and how long it lasted.

Inputs

Call startedcall_start_timedate and timeRequired
When the call started. Bigin only accepts a call that is over, so the start plus the length can't be in the future.
Length in minutesduration_minutesnumberRequired
How long it lasted. Use 0 for a missed call.From 0 to 5999.
Call typecall_typetextRequired
Whether it was made, received or missed.One of: Outbound, Inbound, Missed.
Subjectsubjecttext
What the call was about.
Contact IDcontact_idtext
The id of the contact who was called.
Related torelated_moduletext
Choose together with the record id.One of: Accounts (Company), Deals (Pipeline record (deal)).
Related record IDrelated_record_idtext
The id of the record this is about.
Descriptiondescriptiontext
Free text kept on the record.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record added",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Search records

Find records by email, phone, any word, or a criteria expression. Bigin's search index lags a little, so a record created seconds ago may not show yet; use 'Get record' for that.

Inputs

Record typemoduletextRequired
What kind of record.One of: Contacts, Accounts (Companies), Pipelines (Pipelines (deals)), Products, Tasks, Events, Calls.
Search bysearch_bytextRequired
What kind of search to run.One of: email (Email address), phone (Phone number), word (Any text), criteria (Criteria expression).
Search forvaluetextRequired
The value to look for. For a criteria expression use Bigin's syntax.
Records per pagelimitnumber
How many to return, 1 to 200. Defaults to 20.From 1 to 200.
Pagepagenumber
Which page to return, 1 to 10 (the first 2,000 records). Defaults to 1.From 1 to 10.

Outputs

countnumber
How many came back on this page
more_recordstrue/false
Whether another page follows
next_page_tokentext
Token for reading past 2,000 records, empty if none
pagenumber
The page number
per_pagenumber
The page size used
recordslist
The matching records
Example output
{
  "count": 1,
  "more_records": false,
  "next_page_token": "",
  "page": 1,
  "per_page": 20,
  "records": [
    {
      "Account_Name": {
        "id": "2034020000000489001",
        "name": "Northwind Traders"
      },
      "All_day": false,
      "Amount": 0,
      "Call_Duration": "",
      "Call_Start_Time": "",
      "Call_Status": "",
      "Call_Type": "",
      "Closing_Date": "",
      "Contact_Name": {
        "id": "",
        "name": ""
      },
      "Created_Time": "2026-10-01T10:20:00+05:30",
      "Deal_Name": "",
      "Description": "",
      "Due_Date": "",
      "Email": "james.bennett@example.com",
      "End_DateTime": "",
      "Event_Title": "",
      "First_Name": "James",
      "Full_Name": "James Bennett",
      "Last_Name": "Bennett",
      "Mobile": "+15555550100",
      "Modified_Time": "2026-10-02T09:00:00+05:30",
      "Owner": {
        "email": "dana@example.com",
        "id": "2034020000000312001",
        "name": "Dana Reed"
      },
      "Phone": "",
      "Pipeline": {
        "id": "",
        "name": ""
      },
      "Priority": "",
      "Product_Active": false,
      "Product_Category": "",
      "Product_Code": "",
      "Product_Name": "",
      "Stage": "",
      "Start_DateTime": "",
      "Status": "",
      "Sub_Pipeline": "",
      "Subject": "",
      "Title": "Buyer",
      "Unit_Price": 0,
      "Venue": "",
      "Website": "",
      "id": "2034020000000489034"
    }
  ]
}

Update company

Change a company. Fields left empty stay as they are.

Inputs

Company IDcompany_idtextRequired
The company's id, from 'List records' or an earlier step.
Company namecompany_nametext
A new name.
Phonephonetext
The company's phone number.
Websitewebsitetext
The company's website.
Descriptiondescriptiontext
Free text kept on the record.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record updated",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Update contact

Change a contact. Fields left empty stay as they are.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List records' or an earlier step.
Last namelast_nametext
A new last name.
First namefirst_nametext
A new first name.
Emailemailtext
The contact's email address.
Mobilemobiletext
The contact's mobile number.
Phonephonetext
The contact's phone number.
Titletitletext
The contact's job title.
Company IDcompany_idtext
The id of the company the contact works for.
Descriptiondescriptiontext
Free text kept on the record.
Email opt outemail_opt_outtrue/false
Turn on if the contact asked not to get emails.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record updated",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Update event

Change an event. Give both the start and the end to move it.

Inputs

Event IDevent_idtextRequired
The event's id, from 'List records' or an earlier step.
Titletitletext
A new title.
Startsstart_timedate and time
When the event starts.
Endsend_timedate and time
When the event ends, after the start.
Venuevenuetext
Where it takes place.
Descriptiondescriptiontext
Free text kept on the record.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record updated",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Update note

Change a note's title or text.

Inputs

Record typemoduletextRequired
What kind of record.One of: Contacts, Accounts (Companies), Pipelines (Pipelines (deals)), Products, Tasks, Events, Calls.
Record IDrecord_idtextRequired
The record's id, from 'List records' or an earlier step, or a Bigin address ending in it.
Note IDnote_idtextRequired
The note's id, from 'List notes' or an earlier step.
Notecontenttext
The new text.
Titletitletext
The new title.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record updated",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Update pipeline record

Change a pipeline record, for instance to move it to another stage. Fields left empty stay as they are.

Inputs

Pipeline record IDdeal_idtextRequired
The id from 'List records' (choose Pipelines) or an earlier step.
Namedeal_nametext
A new name.
Sub-pipelinesub_pipelinetext
The sub-pipeline the record belongs to.
Stagestagetext
The stage, one that belongs to the sub-pipeline.
Amountamountnumber
The value of the record.At least 0.
Closing dateclosing_datedate
When it is expected to close.
Company IDcompany_idtext
The id of the company it is for.
Contact IDcontact_idtext
The id of the contact it is for.
Descriptiondescriptiontext
Free text kept on the record.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record updated",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Update product

Change a product. Fields left empty stay as they are.

Inputs

Product IDproduct_idtextRequired
The product's id, from 'List records' or an earlier step.
Product nameproduct_nametext
A new name.
Product codeproduct_codetext
The product's code or SKU.
Unit priceunit_pricenumber
The price of one.At least 0.
Activeactivetrue/false
Whether the product can be sold.
Descriptiondescriptiontext
Free text kept on the record.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record updated",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

Update task

Change a task, for instance to mark it completed.

Inputs

Task IDtask_idtextRequired
The task's id, from 'List records' or an earlier step.
Subjectsubjecttext
A new subject.
Due datedue_datedate
When the task is due.
Statusstatustext
The task's status, from your account's list.
Priorityprioritytext
The task's priority, from your account's list.
Descriptiondescriptiontext
Free text kept on the record.
Ownerowner_idtext
The Bigin user who owns the record. Pick one or give a user id.
Other fieldsextra_fieldsobject
Any other Bigin fields to set, each field's API name with its value. Use it for your account's custom fields. Find the names with 'List fields'.

Outputs

created_timetext
When the record was created
idtext
The id of the record written
messagetext
What Bigin said it did, such as record added
modified_timetext
When the record was last changed
Example output
{
  "created_time": "2026-10-01T10:20:00+05:30",
  "id": "2034020000000489034",
  "message": "record updated",
  "modified_time": "2026-10-01T10:20:00+05:30"
}

On this page