TextIt API reference

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

Broadcasts

list

broadcasts.list List outgoing broadcasts. Risk: read

await corsair.textit.api.broadcasts.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`before`	`string`	No	—
`after`	`string`	No	—
`uuid`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  urns?: string[] | null,
  contacts?: {
    uuid?: string | null,
    name?: string | null
  }[] | null,
  groups?: {
    uuid?: string | null,
    name?: string | null
  }[] | null,
  text?: Record<string, string> | null,
  attachments?: Record<string, string[]> | null,
  quick_replies?: Record<string, {
    type?: string | null,
    text?: string | null,
    extra?: string | null
  }[]> | null,
  base_language?: string | null,
  status?: string | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

send

broadcasts.send Send a translated broadcast to contacts, groups or URNs; it messages real people. Risk: destructive

await corsair.textit.api.broadcasts.send({
	contacts: ['09d23a05-47fe-11e4-bfe9-b8f6b119e9ab'],
	text: { eng: 'Hello!' },
});

Input

Name	Type	Required	Description
`urns`	`string[]`	No	—
`contacts`	`string[]`	No	—
`groups`	`string[]`	No	—
`text`	`Record<string, string>`	Yes	—
`attachments`	`Record<string, string[]>`	No	—
`quick_replies`	`object`	No	—
`base_language`	`string`	No	—

quick_replies full type

Record<string, {
  type?: text | form | url | location,
  text: string,
  extra?: string
}[]>

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`urns`	`string[] \| null`	No	—
`contacts`	`object[] \| null`	No	—
`groups`	`object[] \| null`	No	—
`text`	`Record<string, string> \| null`	No	—
`attachments`	`Record<string, string[]> \| null`	No	—
`quick_replies`	`object \| null`	No	—
`base_language`	`string \| null`	No	—
`status`	`string \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

contacts full type

{
  uuid?: string | null,
  name?: string | null
}[] | null

groups full type

{
  uuid?: string | null,
  name?: string | null
}[] | null

quick_replies full type

Record<string, {
  type?: string | null,
  text?: string | null,
  extra?: string | null
}[]> | null

Campaign Events

create

campaignEvents.create Create a campaign event that messages or starts a flow for every contact in the campaign group. Risk: destructive

await corsair.textit.api.campaignEvents.create({ "campaign": "f14e4ff0-724d-43fe-a953-1d16aefd1c00", "relative_to": "registration", "offset": 7, "unit": "days", "delivery_hour": 9, "message": "Hello!" });

Input

Name	Type	Required	Description
`campaign`	`string`	Yes	—
`relative_to`	`string`	Yes	—
`offset`	`number`	Yes	—
`unit`	`minutes \| hours \| days \| weeks`	Yes	—
`delivery_hour`	`number`	Yes	—
`message`	`string`	No	—
`flow`	`string`	No	—

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`campaign`	`object \| null`	No	—
`relative_to`	`object \| null`	No	—
`offset`	`number \| null`	No	—
`unit`	`string \| null`	No	—
`delivery_hour`	`number \| null`	No	—
`message`	`Record<string, string> \| null`	No	—
`flow`	`object \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

campaign full type

{
  uuid?: string | null,
  name?: string | null
} | null

relative_to full type

{
  key?: string | null,
  name?: string | null
} | null

flow full type

{
  uuid?: string | null,
  name?: string | null
} | null

delete

campaignEvents.delete Delete a campaign event. Risk: destructive

await corsair.textit.api.campaignEvents.delete({ uuid: '6a6d7531-6b44-4c45-8c33-957ddd8dfabc' });

Input

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

Output: void

list

campaignEvents.list List campaign events. Risk: read

await corsair.textit.api.campaignEvents.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`uuid`	`string`	No	—
`campaign`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  campaign?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  relative_to?: {
    key?: string | null,
    name?: string | null
  } | null,
  offset?: number | null,
  unit?: string | null,
  delivery_hour?: number | null,
  message?: Record<string, string> | null,
  flow?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

update

campaignEvents.update Update a campaign event that messages or starts a flow for every contact in the campaign group. Risk: destructive

await corsair.textit.api.campaignEvents.update({
	uuid: '6a6d7531-6b44-4c45-8c33-957ddd8dfabc',
	body: {
		campaign: 'f14e4ff0-724d-43fe-a953-1d16aefd1c00',
		relative_to: 'registration',
		offset: 7,
		unit: 'days',
		delivery_hour: 9,
		message: 'Hello!',
	},
});

Input

Name	Type	Required	Description
`uuid`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
  campaign: string,
  relative_to: string,
  offset: number,
  unit: minutes | hours | days | weeks,
  delivery_hour: number,
  message?: string,
  flow?: string
}

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`campaign`	`object \| null`	No	—
`relative_to`	`object \| null`	No	—
`offset`	`number \| null`	No	—
`unit`	`string \| null`	No	—
`delivery_hour`	`number \| null`	No	—
`message`	`Record<string, string> \| null`	No	—
`flow`	`object \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

campaign full type

{
  uuid?: string | null,
  name?: string | null
} | null

relative_to full type

{
  key?: string | null,
  name?: string | null
} | null

flow full type

{
  uuid?: string | null,
  name?: string | null
} | null

Campaigns

create

campaigns.create Create a campaign for a contact group. Risk: write

await corsair.textit.api.campaigns.create({ name: 'Reminders', group: '09d23a05-47fe-11e4-bfe9-b8f6b119e9ab' });

Input

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

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`name`	`string \| null`	No	—
`archived`	`boolean \| null`	No	—
`group`	`object \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

group full type

{
  uuid?: string | null,
  name?: string | null
} | null

list

campaigns.list List campaigns. Risk: read

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

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`before`	`string`	No	—
`after`	`string`	No	—
`uuid`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  name?: string | null,
  archived?: boolean | null,
  group?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

update

campaigns.update Update a campaign by UUID. Risk: write

await corsair.textit.api.campaigns.update({ uuid: 'f14e4ff0-724d-43fe-a953-1d16aefd1c00', name: 'Reminders', group: '09d23a05-47fe-11e4-bfe9-b8f6b119e9ab' });

Input

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

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`name`	`string \| null`	No	—
`archived`	`boolean \| null`	No	—
`group`	`object \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

group full type

{
  uuid?: string | null,
  name?: string | null
} | null

Channels

list

channels.list List messaging channels. Risk: read

await corsair.textit.api.channels.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`uuid`	`string`	No	—
`address`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  name?: string | null,
  address?: string | null,
  type?: string | null,
  country?: string | null,
  device?: {
    name?: string | null,
    power_level?: number | null,
    power_status?: string | null,
    power_source?: string | null,
    network_type?: string | null
  } | null,
  last_seen?: string | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

Contact Actions

apply

contactActions.apply Apply a bulk contact action, including permanent deletion. Risk: destructive

await corsair.textit.api.contactActions.apply({ "contacts": ["d33e9ad5-5c35-414c-abd4-e7451c69ff1d"], "action": "add", "group": "09d23a05-47fe-11e4-bfe9-b8f6b119e9ab" });

Input

Name	Type	Required	Description
`contacts`	`string[]`	Yes	—
`action`	`add \| remove \| block \| unblock \| interrupt \| delete`	Yes	—
`group`	`string`	No	—

Output: void

Contacts

create

contacts.create Create a contact. Risk: write

await corsair.textit.api.contacts.create({});

Input

Name	Type	Required	Description
`name`	`string \| null`	No	—
`language`	`string \| null`	No	—
`urns`	`string[]`	No	—
`groups`	`object[]`	No	—
`fields`	`Record<string, string \| null>`	No	—

groups full type

(string | {
  uuid: string,
  name?: string
})[]

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`name`	`string \| null`	No	—
`status`	`string \| null`	No	—
`language`	`string \| null`	No	—
`urns`	`string[] \| null`	No	—
`email`	`string \| null`	No	—
`email_verified_on`	`string \| null`	No	—
`groups`	`object[] \| null`	No	—
`fields`	`Record<string, any> \| null`	No	—
`flow`	`object \| null`	No	—
`last_seen_on`	`string \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

groups full type

{
  uuid?: string | null,
  name?: string | null
}[] | null

flow full type

{
  uuid?: string | null,
  name?: string | null
} | null

delete

contacts.delete Permanently delete a contact by UUID or URN. Risk: destructive · Irreversible

await corsair.textit.api.contacts.delete({ uuid: 'd33e9ad5-5c35-414c-abd4-e7451c69ff1d' });

Input: object

Input full type

{
  uuid: string
} | {
  urn: string
}

Output: void

list

contacts.list List contacts and their custom fields. Risk: read

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

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`before`	`string`	No	—
`after`	`string`	No	—
`uuid`	`string`	No	—
`urn`	`string`	No	—
`group`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  name?: string | null,
  status?: string | null,
  language?: string | null,
  urns?: string[] | null,
  email?: string | null,
  email_verified_on?: string | null,
  groups?: {
    uuid?: string | null,
    name?: string | null
  }[] | null,
  fields?: Record<string, any> | null,
  flow?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  last_seen_on?: string | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

update

contacts.update Update a contact by UUID or URN; an unknown URN creates one. Risk: write

await corsair.textit.api.contacts.update({
	query: { uuid: 'd33e9ad5-5c35-414c-abd4-e7451c69ff1d' },
	body: { name: 'Bob' },
});

Input

Name	Type	Required	Description
`query`	`object`	Yes	—
`body`	`object`	Yes	—

query full type

{
  uuid: string
} | {
  urn: string
}

body full type

{
  name?: string | null,
  language?: string | null,
  urns?: string[],
  groups?: (string | {
    uuid: string,
    name?: string
  })[],
  fields?: Record<string, string | null>
}

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`name`	`string \| null`	No	—
`status`	`string \| null`	No	—
`language`	`string \| null`	No	—
`urns`	`string[] \| null`	No	—
`email`	`string \| null`	No	—
`email_verified_on`	`string \| null`	No	—
`groups`	`object[] \| null`	No	—
`fields`	`Record<string, any> \| null`	No	—
`flow`	`object \| null`	No	—
`last_seen_on`	`string \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

groups full type

{
  uuid?: string | null,
  name?: string | null
}[] | null

flow full type

{
  uuid?: string | null,
  name?: string | null
} | null

Fields

create

fields.create Create a custom contact field. Risk: write

await corsair.textit.api.fields.create({ "name": "Nickname", "type": "text" });

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`type`	`text \| number \| datetime \| state \| district \| ward`	Yes	—

Output

Name	Type	Required	Description
`key`	`string \| null`	No	—
`name`	`string \| null`	No	—
`type`	`string \| null`	No	—

list

fields.list List custom contact fields. Risk: read

await corsair.textit.api.fields.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`key`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  key?: string | null,
  name?: string | null,
  type?: string | null
}[]

update

fields.update Update a custom contact field by key. Risk: write

await corsair.textit.api.fields.update({ "key": "nickname", "name": "Nickname", "type": "text" });

Input

Name	Type	Required	Description
`key`	`string`	Yes	—
`name`	`string`	Yes	—
`type`	`text \| number \| datetime \| state \| district \| ward`	Yes	—

Output

Name	Type	Required	Description
`key`	`string \| null`	No	—
`name`	`string \| null`	No	—
`type`	`string \| null`	No	—

Flows

list

flows.list List flows. Risk: read

await corsair.textit.api.flows.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`before`	`string`	No	—
`after`	`string`	No	—
`uuid`	`string`	No	—
`type`	`message \| voice \| survey`	No	—
`archived`	`boolean`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  name?: string | null,
  type?: string | null,
  archived?: boolean | null,
  labels?: {
    uuid?: string | null,
    name?: string | null
  }[] | null,
  expires?: number | null,
  runs?: {
    active?: number | null,
    completed?: number | null,
    interrupted?: number | null,
    expired?: number | null
  } | null,
  results?: {
    key?: string | null,
    name?: string | null,
    categories?: string[] | null,
    node_uuids?: string[] | null
  }[] | null,
  parent_refs?: string[] | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

Flow Starts

create

flowStarts.create Start contacts, groups or URNs in a flow, which can message them. Risk: destructive

await corsair.textit.api.flowStarts.create({
	flow: '5f05311e-8f81-4a67-a5b5-1501b6d6496a',
	contacts: ['d33e9ad5-5c35-414c-abd4-e7451c69ff1d'],
});

Input

Name	Type	Required	Description
`flow`	`string`	Yes	—
`groups`	`string[]`	No	—
`contacts`	`string[]`	No	—
`urns`	`string[]`	No	—
`restart_participants`	`boolean`	No	—
`exclude_active`	`boolean`	No	—
`params`	`Record<string, any>`	No	—

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`flow`	`object \| null`	No	—
`contacts`	`object[] \| null`	No	—
`groups`	`object[] \| null`	No	—
`status`	`string \| null`	No	—
`params`	`Record<string, any> \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

flow full type

{
  uuid?: string | null,
  name?: string | null
} | null

contacts full type

{
  uuid?: string | null,
  name?: string | null
}[] | null

groups full type

{
  uuid?: string | null,
  name?: string | null
}[] | null

list

flowStarts.list List manual flow starts. Risk: read

await corsair.textit.api.flowStarts.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`uuid`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  flow?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  contacts?: {
    uuid?: string | null,
    name?: string | null
  }[] | null,
  groups?: {
    uuid?: string | null,
    name?: string | null
  }[] | null,
  status?: string | null,
  params?: Record<string, any> | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

Globals

create

globals.create Create a workspace global. Risk: write

await corsair.textit.api.globals.create({ name: 'Greeting', value: 'Hello' });

Input

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

Output

Name	Type	Required	Description
`key`	`string \| null`	No	—
`name`	`string \| null`	No	—
`value`	`string \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

list

globals.list List workspace globals. Risk: read

await corsair.textit.api.globals.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`before`	`string`	No	—
`after`	`string`	No	—
`key`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  key?: string | null,
  name?: string | null,
  value?: string | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

update

globals.update Update a workspace global by key. Risk: write

await corsair.textit.api.globals.update({ key: 'greeting', value: 'Hello' });

Input

Name	Type	Required	Description
`key`	`string`	Yes	—
`name`	`string`	No	—
`value`	`string`	No	—

Output

Name	Type	Required	Description
`key`	`string \| null`	No	—
`name`	`string \| null`	No	—
`value`	`string \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

Groups

create

groups.create Create a contact group. Risk: write

await corsair.textit.api.groups.create({ name: 'Volunteers' });

Input

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

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`name`	`string \| null`	No	—
`query`	`string \| null`	No	—
`status`	`string \| null`	No	—
`system`	`boolean \| null`	No	—
`count`	`number \| null`	No	—

delete

groups.delete Delete a contact group. Risk: destructive

await corsair.textit.api.groups.delete({ uuid: '09d23a05-47fe-11e4-bfe9-b8f6b119e9ab' });

Input

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

Output: void

list

groups.list List contact groups. Risk: read

await corsair.textit.api.groups.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`uuid`	`string`	No	—
`name`	`string`	No	—
`manual_only`	`1 \| 0`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  name?: string | null,
  query?: string | null,
  status?: string | null,
  system?: boolean | null,
  count?: number | null
}[]

update

groups.update Update a contact group. Risk: write

await corsair.textit.api.groups.update({ uuid: '09d23a05-47fe-11e4-bfe9-b8f6b119e9ab', name: 'Volunteers' });

Input

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

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`name`	`string \| null`	No	—
`query`	`string \| null`	No	—
`status`	`string \| null`	No	—
`system`	`boolean \| null`	No	—
`count`	`number \| null`	No	—

Labels

create

labels.create Create a message label. Risk: write

await corsair.textit.api.labels.create({ name: 'Important' });

Input

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

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`name`	`string \| null`	No	—
`count`	`number \| null`	No	—

delete

labels.delete Delete a message label. Risk: destructive

await corsair.textit.api.labels.delete({ uuid: '5a4eb79e-1b1f-4ae3-8700-09384cca385f' });

Input

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

Output: void

list

labels.list List message labels. Risk: read

await corsair.textit.api.labels.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`uuid`	`string`	No	—
`name`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  name?: string | null,
  count?: number | null
}[]

update

labels.update Update a message label. Risk: write

await corsair.textit.api.labels.update({ uuid: '5a4eb79e-1b1f-4ae3-8700-09384cca385f', name: 'Important' });

Input

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

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`name`	`string \| null`	No	—
`count`	`number \| null`	No	—

Media

upload

media.upload Upload a media file for message attachments. Risk: write

await corsair.textit.api.media.upload({ file: new Blob(['example'], { type: 'text/plain' }) });

Input

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

Output

Name	Type	Required	Description
`uuid`	`string`	Yes	—
`content_type`	`string`	Yes	—
`url`	`string`	Yes	—
`filename`	`string`	Yes	—
`size`	`number`	Yes	—

Message Actions

apply

messageActions.apply Label, archive, restore or permanently delete incoming messages by integer id; inspect failures. Risk: destructive

await corsair.textit.api.messageActions.apply({ "messages": [123], "action": "archive" });

Input

Name	Type	Required	Description
`messages`	`number[]`	Yes	—
`action`	`label \| unlabel \| archive \| restore \| delete`	Yes	—
`label`	`string`	No	—

Output: void \| object

Output full type

void | {
  failures: number[]
}

Messages

list

messages.list List messages with optional folder and label filters. Risk: read

await corsair.textit.api.messages.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`before`	`string`	No	—
`after`	`string`	No	—
`uuid`	`string`	No	—
`label`	`string`	No	—
`folder`	`inbox \| flows \| archived \| outbox \| sent \| failed`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  id?: number | null,
  uuid?: string | null,
  contact?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  urn?: string | null,
  channel?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  direction?: string | null,
  type?: string | null,
  status?: string | null,
  visibility?: string | null,
  text?: string | null,
  attachments?: {
    content_type?: string | null,
    url?: string | null
  }[] | null,
  quick_replies?: {
    type?: string | null,
    text?: string | null,
    extra?: string | null
  }[] | null,
  labels?: {
    uuid?: string | null,
    name?: string | null
  }[] | null,
  flow?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  sent_on?: string | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

send

messages.send Send a message to a contact; it messages a real person. Risk: destructive

await corsair.textit.api.messages.send({ contact: 'd33e9ad5-5c35-414c-abd4-e7451c69ff1d', text: 'Hello!' });

Input

Name	Type	Required	Description
`contact`	`string`	Yes	—
`text`	`string`	Yes	—
`attachments`	`string[]`	No	—
`quick_replies`	`object[]`	No	—

quick_replies full type

{
  type?: text | form | url | location,
  text: string,
  extra?: string
}[]

Output

Name	Type	Required	Description
`id`	`number \| null`	No	—
`uuid`	`string \| null`	No	—
`contact`	`object \| null`	No	—
`urn`	`string \| null`	No	—
`channel`	`object \| null`	No	—
`direction`	`string \| null`	No	—
`type`	`string \| null`	No	—
`status`	`string \| null`	No	—
`visibility`	`string \| null`	No	—
`text`	`string \| null`	No	—
`attachments`	`object[] \| null`	No	—
`quick_replies`	`object[] \| null`	No	—
`labels`	`object[] \| null`	No	—
`flow`	`object \| null`	No	—
`sent_on`	`string \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

contact full type

{
  uuid?: string | null,
  name?: string | null
} | null

channel full type

{
  uuid?: string | null,
  name?: string | null
} | null

attachments full type

{
  content_type?: string | null,
  url?: string | null
}[] | null

quick_replies full type

{
  type?: string | null,
  text?: string | null,
  extra?: string | null
}[] | null

labels full type

{
  uuid?: string | null,
  name?: string | null
}[] | null

flow full type

{
  uuid?: string | null,
  name?: string | null
} | null

Resthook Events

list

resthookEvents.list List outbound resthook events. Risk: read

await corsair.textit.api.resthookEvents.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`resthook`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  resthook?: string | null,
  data?: Record<string, any> | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

Resthooks

list

resthooks.list List outbound resthooks. Risk: read

await corsair.textit.api.resthooks.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  resthook?: string | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

Resthook Subscribers

create

resthookSubscribers.create Subscribe a target URL to a resthook. Risk: write

await corsair.textit.api.resthookSubscribers.create({ resthook: 'new-report', target_url: 'https://example.com/hook' });

Input

Name	Type	Required	Description
`resthook`	`string`	Yes	—
`target_url`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string \| number \| null`	No	—
`resthook`	`string \| null`	No	—
`target_url`	`string \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

delete

resthookSubscribers.delete Remove an outbound resthook subscription. Risk: destructive

await corsair.textit.api.resthookSubscribers.delete({ id: 10404016 });

Input

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

Output: void

list

resthookSubscribers.list List outbound resthook subscribers. Risk: read

await corsair.textit.api.resthookSubscribers.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`id`	`string \| number`	No	—
`resthook`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  id?: string | number | null,
  resthook?: string | null,
  target_url?: string | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

Runs

list

runs.list List flow runs. Risk: read

await corsair.textit.api.runs.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`before`	`string`	No	—
`after`	`string`	No	—
`uuid`	`string`	No	—
`flow`	`string`	No	—
`responded`	`boolean`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  flow?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  contact?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  start?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  responded?: boolean | null,
  values?: Record<string, {
    name?: string | null,
    value?: string | null,
    category?: string | null,
    node?: string | null,
    time?: string | null
  }> | {
    name?: string | null,
    value?: string | null,
    category?: string | null,
    node?: string | null,
    time?: string | null
  }[] | null,
  exited_on?: string | null,
  exit_type?: string | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

Ticket Actions

apply

ticketActions.apply Apply a bulk ticket action. Risk: write

await corsair.textit.api.ticketActions.apply({ "tickets": ["9a8b001e-a913-486c-80f4-1356e23f582e"], "action": "close" });

Input

Name	Type	Required	Description
`tickets`	`string[]`	Yes	—
`action`	`assign \| note \| close \| reopen`	Yes	—
`assignee`	`string`	No	—
`note`	`string`	No	—

Output: void

Tickets

list

tickets.list List support tickets. Risk: read

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

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`uuid`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  contact?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  status?: string | null,
  topic?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  assignee?: {
    email?: string | null,
    name?: string | null
  } | null,
  opened_on?: string | null,
  opened_by?: {
    email?: string | null,
    name?: string | null
  } | null,
  opened_in?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  closed_on?: string | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

Topics

create

topics.create Create a ticket topic. Risk: write

await corsair.textit.api.topics.create({ name: 'Support' });

Input

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

Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`name`	`string \| null`	No	—
`counts`	`object \| null`	No	—
`system`	`boolean \| null`	No	—
`created_on`	`string \| null`	No	—
`modified_on`	`string \| null`	No	—

counts full type

{
  open?: number | null,
  closed?: number | null
} | null

list

topics.list List ticket topics. Risk: read

await corsair.textit.api.topics.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  name?: string | null,
  counts?: {
    open?: number | null,
    closed?: number | null
  } | null,
  system?: boolean | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

Users

list

users.list List workspace users. Risk: read

await corsair.textit.api.users.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`uuid`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string \| null`	Yes	—
`previous`	`string \| null`	Yes	—
`results`	`object[]`	Yes	—
`count`	`number`	No	—

results full type

{
  uuid?: string | null,
  avatar?: string | null,
  email?: string | null,
  first_name?: string | null,
  last_name?: string | null,
  role?: string | null,
  team?: {
    uuid?: string | null,
    name?: string | null
  } | null,
  created_on?: string | null,
  modified_on?: string | null
}[]

Workspace

get

workspace.get Read current workspace details. Risk: read

await corsair.textit.api.workspace.get({});

Input: empty object Output

Name	Type	Required	Description
`uuid`	`string \| null`	No	—
`name`	`string \| null`	No	—
`country`	`string \| null`	No	—
`languages`	`string[] \| null`	No	—
`timezone`	`string \| null`	No	—
`date_style`	`string \| null`	No	—
`anon`	`boolean \| null`	No	—

Archives

list

Broadcasts

list

send

Campaign Events

create

delete

list

update

Campaigns

create

list

update

Channels

list

Contact Actions

apply

Contacts

create

delete

list

update

Fields

create

list

update

Flows

list

Flow Starts

create

list

Globals

create

list

update

Groups

create

delete

list

update

Labels

create

delete

list

update

Media

upload

Message Actions

apply

Messages

list

send

Resthook Events

list

Resthooks

list

Resthook Subscribers

create

delete

list

Runs

list

Ticket Actions

apply

Tickets

list

Topics

create

list

Users

list

Workspace

get