API - Corsair

Every spoki.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.

Accounts

createOnboardingLink

accounts.createOnboardingLink Create an account onboarding link Risk: write

await corsair.spoki.api.accounts.createOnboardingLink({});

Input

Name	Type	Required	Description
`accountId`	`number`	Yes	—

Output: object

Output full type

{
}

getAccount

accounts.getAccount Retrieve a Spoki account Risk: read

await corsair.spoki.api.accounts.getAccount({});

Input

Name	Type	Required	Description
`accountId`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`current_credit`	`number`	Yes	—
`status`	`string`	Yes	—
`default_language`	`string`	Yes	—
`phone`	`string`	No	—
`has_official_verification`	`boolean`	Yes	—
`daily_limit`	`number`	Yes	—
`phone_status`	`string`	Yes	—
`quality_score`	`number`	Yes	—
`quality_reasons`	`any`	No	—
`is_active`	`boolean`	Yes	—
`country_code`	`string`	Yes	—
`estimated_available_conversations`	`number`	Yes	—
`account_type`	`number`	Yes	—
`default_pricing_delta`	`number`	Yes	—
`low_credit_threshold`	`number`	Yes	—
`has_low_credit_alert`	`boolean`	Yes	—
`default_prefix`	`string`	Yes	—
`default_country_code`	`string`	Yes	—
`timezone`	`string`	Yes	—
`contacted_in_24h`	`number`	Yes	—
`contacted_in_7d`	`number`	Yes	—
`primary_channel_id`	`number`	No	—
`channels`	`object[]`	No	—

channels full type

{
  name: string,
  identifier: string,
  platform: string,
  status: string,
  phone_status: string,
  quality_score: string,
  is_primary: boolean
}[]

getAccountByPhone

accounts.getAccountByPhone Retrieve a Spoki account by phone Risk: read

await corsair.spoki.api.accounts.getAccountByPhone({});

Input

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

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`current_credit`	`number`	Yes	—
`status`	`string`	Yes	—
`default_language`	`string`	Yes	—
`phone`	`string`	No	—
`has_official_verification`	`boolean`	Yes	—
`daily_limit`	`number`	Yes	—
`phone_status`	`string`	Yes	—
`quality_score`	`number`	Yes	—
`quality_reasons`	`any`	No	—
`is_active`	`boolean`	Yes	—
`country_code`	`string`	Yes	—
`estimated_available_conversations`	`number`	Yes	—
`account_type`	`number`	Yes	—
`default_pricing_delta`	`number`	Yes	—
`low_credit_threshold`	`number`	Yes	—
`has_low_credit_alert`	`boolean`	Yes	—
`default_prefix`	`string`	Yes	—
`default_country_code`	`string`	Yes	—
`timezone`	`string`	Yes	—
`contacted_in_24h`	`number`	Yes	—
`contacted_in_7d`	`number`	Yes	—
`primary_channel_id`	`number`	No	—
`channels`	`object[]`	No	—

channels full type

{
  name: string,
  identifier: string,
  platform: string,
  status: string,
  phone_status: string,
  quality_score: string,
  is_primary: boolean
}[]

getCurrentReport

accounts.getCurrentReport Get the current account report Risk: read

await corsair.spoki.api.accounts.getCurrentReport({});

Input

Name	Type	Required	Description
`accountId`	`number`	Yes	—

Output: object

Output full type

{
}[] | {
}

listAccounts

accounts.listAccounts List Spoki WhatsApp accounts Risk: read

await corsair.spoki.api.accounts.listAccounts({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object[]

Output full type

{
  id: number,
  name: string,
  current_credit: number,
  status: string,
  default_language: string,
  phone?: string | null,
  has_official_verification: boolean,
  daily_limit: number,
  phone_status: string,
  quality_score: number,
  quality_reasons?: any,
  is_active: boolean,
  country_code: string,
  estimated_available_conversations: number,
  account_type: number,
  default_pricing_delta: number,
  low_credit_threshold: number,
  has_low_credit_alert: boolean,
  default_prefix: string,
  default_country_code: string,
  timezone: string,
  contacted_in_24h: number,
  contacted_in_7d: number,
  primary_channel_id?: number | null,
  channels?: {
    name: string,
    identifier: string,
    platform: string,
    status: string,
    phone_status: string,
    quality_score: string,
    is_primary: boolean
  }[]
}[]

Agencies

list

agencies.list List agencies Risk: read

await corsair.spoki.api.agencies.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

Automation

triggerAutomation

automation.triggerAutomation Trigger a Spoki automation Risk: write

await corsair.spoki.api.automation.triggerAutomation({});

Input

Name	Type	Required	Description
`uuid`	`string`	Yes	—
`secret`	`string`	Yes	—
`phone`	`string`	Yes	—
`first_name`	`string`	No	—
`last_name`	`string`	No	—
`email`	`string`	No	—
`language`	`string`	No	—
`custom_fields`	`object`	No	—
`metadata`	`object`	No	—

custom_fields full type

{
}

metadata full type

{
}

Output: empty object

Automations

list

automations.list List automations Risk: read

await corsair.spoki.api.automations.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

retrieve

automations.retrieve Retrieve an automation Risk: read

await corsair.spoki.api.automations.retrieve({});

Input

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

Output: object

Output full type

{
}

Campaigns

list

campaigns.list List campaigns Risk: read

await corsair.spoki.api.campaigns.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

update

campaigns.update Update a campaign Risk: write

await corsair.spoki.api.campaigns.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`scheduled_datetime`	`string`	No	—

Output: object

Output full type

{
}

Contacts

addOperator

contacts.addOperator Assign an operator to a contact Risk: write

await corsair.spoki.api.contacts.addOperator({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`operator_id`	`number`	No	—
`role_id`	`number`	No	—

Output: object

Output full type

{
}

createOrUpdate

contacts.createOrUpdate Create or update a contact by phone Risk: write

await corsair.spoki.api.contacts.createOrUpdate({});

Input

Name	Type	Required	Description
`phone`	`string`	Yes	—
`first_name`	`string`	No	—
`last_name`	`string`	No	—
`email`	`string`	No	—
`language`	`string`	No	—

Output: object

Output full type

{
}

delete

contacts.delete Delete a contact Risk: destructive · Irreversible

await corsair.spoki.api.contacts.delete({});

Input

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

Output: object[]

Output full type

{
} | any[]

list

contacts.list List contacts Risk: read

await corsair.spoki.api.contacts.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

removeOperator

contacts.removeOperator Remove an operator from a contact Risk: write

await corsair.spoki.api.contacts.removeOperator({});

Input

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

Output: object

Output full type

{
}

retrieve

contacts.retrieve Retrieve a contact Risk: read

await corsair.spoki.api.contacts.retrieve({});

Input

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

Output: object

Output full type

{
}

syncBulk

contacts.syncBulk Bulk sync contacts Risk: write

await corsair.spoki.api.contacts.syncBulk({});

Input

Name	Type	Required	Description
`contacts`	`any[]`	Yes	—

Output: object

Output full type

{
}

update

contacts.update Update a contact Risk: write

await corsair.spoki.api.contacts.update({});

Input

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

Output: object

Output full type

{
}

Custom Fields

create

customFields.create Create a custom field Risk: write

await corsair.spoki.api.customFields.create({});

Input

Name	Type	Required	Description
`label`	`string`	Yes	—
`code`	`string`	No	—

Output: object

Output full type

{
}

delete

customFields.delete Delete a custom field Risk: destructive · Irreversible

await corsair.spoki.api.customFields.delete({});

Input

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

Output: object

Output full type

{
}

list

customFields.list List custom fields Risk: read

await corsair.spoki.api.customFields.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

retrieve

customFields.retrieve Retrieve a custom field Risk: read

await corsair.spoki.api.customFields.retrieve({});

Input

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

Output: object

Output full type

{
}

update

customFields.update Update a custom field Risk: write

await corsair.spoki.api.customFields.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`label`	`string`	No	—

Output: object

Output full type

{
}

Invitations

resend

invitations.resend Resend an invitation Risk: write

await corsair.spoki.api.invitations.resend({});

Input

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

Output: object

Output full type

{
}

updateRole

invitations.updateRole Update an invitation role Risk: write

await corsair.spoki.api.invitations.updateRole({});

Input

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

Output: object

Output full type

{
}

Lists

create

lists.create Create a contact list Risk: write

await corsair.spoki.api.lists.create({});

Input

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

Output: object

Output full type

{
}

delete

lists.delete Delete a contact list Risk: destructive · Irreversible

await corsair.spoki.api.lists.delete({});

Input

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

Output: object

Output full type

{
}

list

lists.list List contact lists Risk: read

await corsair.spoki.api.lists.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

removeAllContacts

lists.removeAllContacts Remove all contacts from a list Risk: write

await corsair.spoki.api.lists.removeAllContacts({});

Input

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

Output: object

Output full type

{
}

removeContacts

lists.removeContacts Remove contacts from a list Risk: write

await corsair.spoki.api.lists.removeContacts({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`contacts`	`any[]`	No	—

Output: object

Output full type

{
}

retrieve

lists.retrieve Retrieve a contact list Risk: read

await corsair.spoki.api.lists.retrieve({});

Input

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

Output: object

Output full type

{
}

syncContacts

lists.syncContacts Sync contacts into a list Risk: write

await corsair.spoki.api.lists.syncContacts({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`contacts`	`any[]`	Yes	—

Output: object

Output full type

{
}

Media

create

media.create Create a media file Risk: write

await corsair.spoki.api.media.create({});

Input: empty object Output: object

Output full type

{
}

delete

media.delete Delete a media file Risk: destructive · Irreversible

await corsair.spoki.api.media.delete({});

Input

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

Output: object

Output full type

{
}

list

media.list List media files Risk: read

await corsair.spoki.api.media.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

retrieve

media.retrieve Retrieve a media file Risk: read

await corsair.spoki.api.media.retrieve({});

Input

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

Output: object

Output full type

{
}

update

media.update Update a media file Risk: write

await corsair.spoki.api.media.update({});

Input

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

Output: object

Output full type

{
}

Messaging

sendMessage

messaging.sendMessage Send a WhatsApp message Risk: write

await corsair.spoki.api.messaging.sendMessage({});

Input

Name	Type	Required	Description
`phone`	`string`	Yes	—
`text`	`string`	Yes	—
`channel_id`	`number`	No	—
`metadata`	`object`	No	—

metadata full type

{
}

Output: empty object

Partners

list

partners.list List partners Risk: read

await corsair.spoki.api.partners.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

Reports

list

reports.list List usage reports Risk: read

await corsair.spoki.api.reports.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

Roles

addServiceUser

roles.addServiceUser Add a service user Risk: write

await corsair.spoki.api.roles.addServiceUser({});

Input: empty object Output: object

Output full type

{
}

checkPrivateKey

roles.checkPrivateKey Check whether a role has a private key Risk: read

await corsair.spoki.api.roles.checkPrivateKey({});

Input

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

Output: object

Output full type

{
}

delete

roles.delete Delete a role Risk: destructive · Irreversible

await corsair.spoki.api.roles.delete({});

Input

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

Output: object

Output full type

{
}

generatePrivateKey

roles.generatePrivateKey Generate a role private key Risk: write

await corsair.spoki.api.roles.generatePrivateKey({});

Input

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

Output: object

Output full type

{
}

list

roles.list List roles Risk: read

await corsair.spoki.api.roles.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

retrieve

roles.retrieve Retrieve a role Risk: read

await corsair.spoki.api.roles.retrieve({});

Input

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

Output: object

Output full type

{
}

update

roles.update Update a role Risk: write

await corsair.spoki.api.roles.update({});

Input

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

Output: object

Output full type

{
}

Templates

clone

templates.clone Clone a template Risk: write

await corsair.spoki.api.templates.clone({});

Input

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

Output: object

Output full type

{
}

create

templates.create Create a WhatsApp template Risk: write

await corsair.spoki.api.templates.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`category`	`string`	Yes	—
`templatelocalization_set`	`any[]`	Yes	—

Output: object

Output full type

{
}

delete

templates.delete Delete a WhatsApp template Risk: destructive · Irreversible

await corsair.spoki.api.templates.delete({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`force_delete`	`boolean`	No	—

Output: object

Output full type

{
}

list

templates.list List templates Risk: read

await corsair.spoki.api.templates.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

retrieve

templates.retrieve Retrieve a template Risk: read

await corsair.spoki.api.templates.retrieve({});

Input

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

Output: object

Output full type

{
}

revertToDraft

templates.revertToDraft Revert a template to draft Risk: write

await corsair.spoki.api.templates.revertToDraft({});

Input

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

Output: object

Output full type

{
}

update

templates.update Update a WhatsApp template Risk: write

await corsair.spoki.api.templates.update({});

Input

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

Output: object

Output full type

{
}

Tickets

create

tickets.create Create a ticket Risk: write

await corsair.spoki.api.tickets.create({});

Input: empty object Output: object

Output full type

{
}

delete

tickets.delete Delete a ticket Risk: destructive · Irreversible

await corsair.spoki.api.tickets.delete({});

Input

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

Output: object

Output full type

{
}

list

tickets.list List tickets Risk: read

await corsair.spoki.api.tickets.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—
`page`	`number \| string`	No	—
`limit`	`number \| string`	No	—
`offset`	`number \| string`	No	—

Output: object

Output full type

{
}[] | {
}

​Accounts

​createOnboardingLink

​getAccount

​getAccountByPhone

​getCurrentReport

​listAccounts

​Agencies

​list

​Automation

​triggerAutomation

​Automations

​list

​retrieve

​Campaigns

​list

​update

​Contacts

​addOperator

​createOrUpdate

​delete

​list

​removeOperator

​retrieve

​syncBulk

​update

​Custom Fields

​create

​delete

​list

​retrieve

​update

​Invitations

​resend

​updateRole

​Lists

​create

​delete

​list

​removeAllContacts

​removeContacts

​retrieve

​syncContacts

​Media

​create

​delete

​list

​retrieve

​update

​Messaging

​sendMessage

​Partners

​list

​Reports

​list

​Roles

​addServiceUser

​checkPrivateKey

​delete

​generatePrivateKey

​list

​retrieve

​update

​Tags

​list

​retrieve

​Templates

​clone

​create

​delete

​list

​retrieve

​revertToDraft

​update

​Tickets

​create

​delete

​list

Accounts

createOnboardingLink

getAccount

getAccountByPhone

getCurrentReport

listAccounts

Agencies

list

Automation

triggerAutomation

Automations

list

retrieve

Campaigns

list

update

Contacts

addOperator

createOrUpdate

delete

list

removeOperator

retrieve

syncBulk

update

Custom Fields

create

delete

list

retrieve

update

Invitations

resend

updateRole

Lists

create

delete

list

removeAllContacts

removeContacts

retrieve

syncContacts

Media

create

delete

list

retrieve

update

Messaging

sendMessage

Partners

list

Reports

list

Roles

addServiceUser

checkPrivateKey

delete

generatePrivateKey

list

retrieve

update

Tags

list

retrieve

Templates

clone

create

delete

list

retrieve

revertToDraft

update

Tickets

create

delete

list