API - Corsair

Every zohobigin.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Attachments

delete

attachments.delete Delete attachment Risk: destructive

await corsair.zohobigin.api.attachments.delete({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`recordId`	`string`	Yes	—
`attachmentId`	`string`	Yes	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

download

attachments.download Download attachment Risk: read

await corsair.zohobigin.api.attachments.download({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`recordId`	`string`	Yes	—
`attachmentId`	`string`	Yes	—

Output: any

get

attachments.get Get attachments Risk: read

await corsair.zohobigin.api.attachments.get({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`recordId`	`string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—
`fields`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`info`	`object`	No	—

data full type

{
}[]

info full type

{
}

upload

attachments.upload Upload attachment Risk: write

await corsair.zohobigin.api.attachments.upload({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`recordId`	`string`	Yes	—
`file`	`any`	No	—
`attachmentUrl`	`string`	No	—
`attachment_url`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

Bulk

createReadJob

bulk.createReadJob Create bulk read job Risk: write

await corsair.zohobigin.api.bulk.createReadJob({});

Input: object

Input full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

downloadReadResult

bulk.downloadReadResult Download bulk read result Risk: read

await corsair.zohobigin.api.bulk.downloadReadResult({});

Input

Name	Type	Required	Description
`job_id`	`string`	Yes	—

Output: any

getReadJobStatus

bulk.getReadJobStatus Get bulk read job status Risk: read

await corsair.zohobigin.api.bulk.getReadJobStatus({});

Input

Name	Type	Required	Description
`job_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

Metadata

getCustomView

metadata.getCustomView Get custom view Risk: read

await corsair.zohobigin.api.metadata.getCustomView({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`viewId`	`string`	Yes	—

Output

Name	Type	Required	Description
`custom_views`	`object[]`	Yes	—

custom_views full type

{
}[]

getCustomViews

metadata.getCustomViews Get custom views Risk: read

await corsair.zohobigin.api.metadata.getCustomViews({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—

Output

Name	Type	Required	Description
`custom_views`	`object[]`	Yes	—

custom_views full type

{
}[]

getFields

metadata.getFields Get fields Risk: read

await corsair.zohobigin.api.metadata.getFields({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—

Output

Name	Type	Required	Description
`fields`	`object[]`	Yes	—

fields full type

{
}[]

getLayout

metadata.getLayout Get layout Risk: read

await corsair.zohobigin.api.metadata.getLayout({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`layoutId`	`string`	Yes	—

Output

Name	Type	Required	Description
`layouts`	`object[]`	Yes	—

layouts full type

{
}[]

getLayouts

metadata.getLayouts Get layouts Risk: read

await corsair.zohobigin.api.metadata.getLayouts({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—

Output

Name	Type	Required	Description
`layouts`	`object[]`	Yes	—

layouts full type

{
}[]

getModule

metadata.getModule Get module metadata Risk: read

await corsair.zohobigin.api.metadata.getModule({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—

Output

Name	Type	Required	Description
`modules`	`object[]`	Yes	—

modules full type

{
}[]

getModules

metadata.getModules Get modules Risk: read

await corsair.zohobigin.api.metadata.getModules({});

Input: void Output

Name	Type	Required	Description
`modules`	`object[]`	Yes	—

modules full type

{
}[]

getRelatedLists

metadata.getRelatedLists Get related lists Risk: read

await corsair.zohobigin.api.metadata.getRelatedLists({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—

Output

Name	Type	Required	Description
`related_lists`	`object[]`	Yes	—

Notes

create

notes.create Create notes Risk: write

await corsair.zohobigin.api.notes.create({});

Input

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  Note_Title?: string,
  Note_Content: string,
  Parent_Id?: string,
  se_module?: string
}[]

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

createRecordNotes

notes.createRecordNotes Create record notes Risk: write

await corsair.zohobigin.api.notes.createRecordNotes({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`recordId`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  Note_Title?: string,
  Note_Content: string
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

delete

notes.delete Delete notes Risk: destructive

await corsair.zohobigin.api.notes.delete({});

Input

Name	Type	Required	Description
`ids`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

deleteRecordNote

notes.deleteRecordNote Delete record note Risk: destructive

await corsair.zohobigin.api.notes.deleteRecordNote({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`recordId`	`string`	Yes	—
`noteId`	`string`	Yes	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

getAll

notes.getAll Get all notes Risk: read

await corsair.zohobigin.api.notes.getAll({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`fields`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`info`	`object`	No	—

data full type

{
}[]

info full type

{
}

getRecordNotes

notes.getRecordNotes Get record notes Risk: read

await corsair.zohobigin.api.notes.getRecordNotes({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`recordId`	`string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—
`fields`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`info`	`object`	No	—

data full type

{
}[]

info full type

{
}

update

notes.update Update note Risk: write

await corsair.zohobigin.api.notes.update({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`recordId`	`string`	Yes	—
`noteId`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
  Note_Title?: string,
  Note_Content: string
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

Notifications

disable

notifications.disable Disable notifications Risk: write

await corsair.zohobigin.api.notifications.disable({});

Input

Name	Type	Required	Description
`channel_ids`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

enable

notifications.enable Enable notifications Risk: write

await corsair.zohobigin.api.notifications.enable({});

Input

Name	Type	Required	Description
`watch`	`object[]`	Yes	—

watch full type

{
  channel_id: string,
  events: string[],
  token?: string,
  notify_url: string,
  channel_expiry?: string
}[]

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

getDetails

notifications.getDetails Get notification details Risk: read

await corsair.zohobigin.api.notifications.getDetails({});

Input

Name	Type	Required	Description
`module`	`string`	No	—
`channel_id`	`string`	No	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output

Name	Type	Required	Description
`watch`	`object[]`	Yes	—
`info`	`object`	No	—

watch full type

{
}[]

info full type

{
}

updateDetails

notifications.updateDetails Update notification details Risk: write

await corsair.zohobigin.api.notifications.updateDetails({});

Input

Name	Type	Required	Description
`watch`	`object[]`	Yes	—

watch full type

{
  channel_id: string,
  events: string[],
  token?: string,
  notify_url: string,
  channel_expiry?: string
}[]

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

updateInfo

notifications.updateInfo Update notification info Risk: write

await corsair.zohobigin.api.notifications.updateInfo({});

Input

Name	Type	Required	Description
`watch`	`object[]`	Yes	—

watch full type

{
  channel_id: string,
  events: string[],
  token?: string,
  notify_url: string,
  channel_expiry?: string
}[]

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

Records

add

records.add Add records to module Risk: write

await corsair.zohobigin.api.records.add({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	Target module API name e.g. Contacts, Pipelines, Accounts
`data`	`object[]`	Yes	Array of record objects to insert
`trigger`	`string[]`	No	Triggers such as approval, workflow, blueprint

data full type

{
}[]

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

count

records.count Count records Risk: read

await corsair.zohobigin.api.records.count({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`cvid`	`string`	No	—

Output

Name	Type	Required	Description
`count`	`string \| number`	Yes	—

delete

records.delete Delete multiple records Risk: destructive

await corsair.zohobigin.api.records.delete({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`ids`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

deletePhoto

records.deletePhoto Delete record photo Risk: destructive

await corsair.zohobigin.api.records.deletePhoto({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`code`	`string`	Yes	—
`message`	`string`	Yes	—
`status`	`string`	Yes	—

deleteRecord

records.deleteRecord Delete single record Risk: destructive

await corsair.zohobigin.api.records.deleteRecord({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

downloadPhoto

records.downloadPhoto Download record photo Risk: read

await corsair.zohobigin.api.records.downloadPhoto({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`id`	`string`	Yes	—

Output: any

get

records.get Get records from module Risk: read

await corsair.zohobigin.api.records.get({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`fields`	`string`	No	—
`page`	`number`	No	—
`per_page`	`number`	No	—
`sort_by`	`string`	No	—
`sort_order`	`asc \| desc`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`info`	`object`	No	—

data full type

{
}[]

info full type

{
  per_page?: number,
  count?: number,
  page?: number,
  more_records?: boolean
}

getDeleted

records.getDeleted Get deleted records Risk: read

await corsair.zohobigin.api.records.getDeleted({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`type`	`all \| recycle \| permanent`	No	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`info`	`object`	No	—

data full type

{
}[]

info full type

{
}

getPipelines

records.getPipelines Get team pipelines Risk: read

await corsair.zohobigin.api.records.getPipelines({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`fields`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`info`	`object`	No	—

data full type

{
}[]

info full type

{
  per_page?: number,
  count?: number,
  page?: number,
  more_records?: boolean
}

getRecord

records.getRecord Get single record Risk: read

await corsair.zohobigin.api.records.getRecord({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
}[]

getRelated

records.getRelated Get related records Risk: read

await corsair.zohobigin.api.records.getRelated({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`recordId`	`string`	Yes	—
`relatedList`	`string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—
`fields`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`info`	`object`	No	—

data full type

{
}[]

info full type

{
  per_page?: number,
  count?: number,
  page?: number,
  more_records?: boolean
}

search

records.search Search records Risk: read

await corsair.zohobigin.api.records.search({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`criteria`	`string`	No	—
`email`	`string`	No	—
`phone`	`string`	No	—
`word`	`string`	No	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`info`	`object`	No	—

data full type

{
}[]

info full type

{
  per_page?: number,
  count?: number,
  page?: number,
  more_records?: boolean
}

update

records.update Update multiple records Risk: write

await corsair.zohobigin.api.records.update({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
}& {
  id: string
}[]

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

updateRecord

records.updateRecord Update single record Risk: write

await corsair.zohobigin.api.records.updateRecord({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`id`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

updateRelated

records.updateRelated Update related records Risk: write

await corsair.zohobigin.api.records.updateRelated({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`recordId`	`string`	Yes	—
`relatedList`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
}[]

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

uploadPhoto

records.uploadPhoto Upload record photo Risk: write

await corsair.zohobigin.api.records.uploadPhoto({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`id`	`string`	Yes	—
`file`	`any`	Yes	—

Output

Name	Type	Required	Description
`code`	`string`	Yes	—
`message`	`string`	Yes	—
`status`	`string`	Yes	—

upsert

records.upsert Upsert records Risk: write

await corsair.zohobigin.api.records.upsert({});

Input

Name	Type	Required	Description
`module`	`string`	Yes	—
`data`	`object[]`	Yes	—
`duplicate_check_fields`	`string[]`	No	—

data full type

{
}[]

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  code: string,
  details: {
  },
  message: string,
  status: string
}[]

Users

getOrganization

users.getOrganization Get organization details Risk: read

await corsair.zohobigin.api.users.getOrganization({});

Input: void Output

Name	Type	Required	Description
`org`	`object[]`	Yes	—

org full type

{
}[]

getProfiles

users.getProfiles Get profiles Risk: read

await corsair.zohobigin.api.users.getProfiles({});

Input: void Output

Name	Type	Required	Description
`profiles`	`object[]`	Yes	—

profiles full type

{
}[]

getRoles

users.getRoles Get roles Risk: read

await corsair.zohobigin.api.users.getRoles({});

Input: void Output

Name	Type	Required	Description
`roles`	`object[]`	Yes	—

roles full type

{
}[]

getUser

users.getUser Get user Risk: read

await corsair.zohobigin.api.users.getUser({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`users`	`object[]`	Yes	—

users full type

{
}[]

getUsers

users.getUsers Get users Risk: read

await corsair.zohobigin.api.users.getUsers({});

Input

Name	Type	Required	Description
`type`	`ActiveUsers \| DeactiveUsers \| AdminUsers \| AllUsers`	No	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output

Name	Type	Required	Description
`users`	`object[]`	Yes	—
`info`	`object`	No	—

users full type

{
}[]

info full type

{
}

updateUser

users.updateUser Update user Risk: write

await corsair.zohobigin.api.users.updateUser({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`data`	`object`	Yes	—

data full type

{
}

Output

Name	Type	Required	Description
`users`	`object[]`	Yes	—

users full type

{
}[]

updateUsers

users.updateUsers Update users Risk: write

await corsair.zohobigin.api.users.updateUsers({});

Input

Name	Type	Required	Description
`users`	`object[]`	Yes	—

users full type

{
}& {
  id: string
}[]

Output

Name	Type	Required	Description
`users`	`object[]`	Yes	—

users full type

{
}[]

uploadOrgPhoto

users.uploadOrgPhoto Upload organization photo Risk: write

await corsair.zohobigin.api.users.uploadOrgPhoto({});

Input

Name	Type	Required	Description
`file`	`any`	Yes	—

Output

Name	Type	Required	Description
`code`	`string`	Yes	—
`message`	`string`	Yes	—
`status`	`string`	Yes	—

​Attachments

​delete

​download

​get

​upload

​Bulk

​createReadJob

​downloadReadResult

​getReadJobStatus

​Metadata

​getCustomView

​getCustomViews

​getFields

​getLayout

​getLayouts

​getModule

​getModules

​getRelatedLists

​Notes

​create

​createRecordNotes

​delete

​deleteRecordNote

​getAll

​getRecordNotes

​update

​Notifications

​disable

​enable

​getDetails

​updateDetails

​updateInfo

​Records

​add

​count

​delete

​deletePhoto

​deleteRecord

​downloadPhoto

​get

​getDeleted

​getPipelines

​getRecord

​getRelated

​search

​update

​updateRecord

​updateRelated

​uploadPhoto

​upsert

​Tags

​addToRecords

​create

​delinkRelated

​Users

​getOrganization

​getProfiles

​getRoles

​getUser

​getUsers

​updateUser

​updateUsers

​uploadOrgPhoto

Attachments

delete

download

get

upload

Bulk

createReadJob

downloadReadResult

getReadJobStatus

Metadata

getCustomView

getCustomViews

getFields

getLayout

getLayouts

getModule

getModules

getRelatedLists

Notes

create

createRecordNotes

delete

deleteRecordNote

getAll

getRecordNotes

update

Notifications

disable

enable

getDetails

updateDetails

updateInfo

Records

add

count

delete

deletePhoto

deleteRecord

downloadPhoto

get

getDeleted

getPipelines

getRecord

getRelated

search

update

updateRecord

updateRelated

uploadPhoto

upsert

Tags

addToRecords

create

delinkRelated

Users

getOrganization

getProfiles

getRoles

getUser

getUsers

updateUser

updateUsers

uploadOrgPhoto