> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Freshdesk API reference

> API reference for the Freshdesk plugin in Corsair: every `freshdesk.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Routes

### addNoteToATicketPostNotes.run

`routes.addNoteToATicketPostNotes.run`

Create a Note: POST /api/v2/tickets/\[ticket\_id]/notes (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.addNoteToATicketPostNotes.run({ pathParams: { ticketId: '123' }, body: { body: 'Internal note', private: true } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   ticketId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   attachments?: JsonValue[] | null,
>   body?: string | null,
>   structured_body?: Record<string, JsonValue> | null,
>   incoming?: boolean | null,
>   notify_emails?: string[] | null,
>   private?: boolean | null,
>   user_id?: number | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### addOrRemoveAgentInAGroupPatchAgents.run

`routes.addOrRemoveAgentInAGroupPatchAgents.run`

Add or Remove Agents in a Group: PATCH /api/v2/admin/groups/\[id]/agents (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.addOrRemoveAgentInAGroupPatchAgents.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   agents?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### archiveTicketsDelete.run

`routes.archiveTicketsDelete.run`

Archive Tickets: DELETE /api/v2/tickets/archived/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.archiveTicketsDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### archiveTicketsGet.run

`routes.archiveTicketsGet.run`

Archive Tickets: GET /api/v2/tickets/archived/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.archiveTicketsGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### archiveTicketsGetConversations.run

`routes.archiveTicketsGetConversations.run`

Archive Tickets: GET /api/v2/tickets/archived/\[id]/conversations (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.archiveTicketsGetConversations.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### bulkCreateCannedResponsesPostBulk.run

`routes.bulkCreateCannedResponsesPostBulk.run`

Bulk Create Canned Responses: POST /api/v2/canned\_responses/bulk (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.bulkCreateCannedResponsesPostBulk.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title?: string | null,
>   content_html?: string | null,
>   folder_id?: number | null,
>   visibility?: number | null,
>   group_ids?: number[] | null,
>   attachments?: JsonValue[] | null,
>   canned_responses?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### bulkDeleteTicketsPostBulkDelete.run

`routes.bulkDeleteTicketsPostBulkDelete.run`

Delete Multiple Tickets: POST /api/v2/tickets/bulk\_delete (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.bulkDeleteTicketsPostBulkDelete.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   bulk_action?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### bulkUpdateTicketsPostBulkUpdate.run

`routes.bulkUpdateTicketsPostBulkUpdate.run`

Update Multiple Tickets: POST /api/v2/tickets/bulk\_update (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.bulkUpdateTicketsPostBulkUpdate.run({ body: { bulk_action: { ids: [20, 21], properties: { status: 4 } } } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   bulk_action?: Record<string, JsonValue> | null,
>   ids?: number[] | null,
>   properties?: Record<string, JsonValue> | null,
>   reply?: Record<string, JsonValue> | null,
>   attachment_ids?: number[] | null,
>   inline_attachment_ids?: number[] | null,
>   cloud_files?: JsonValue[] | null,
>   from_email?: string | null,
>   skip_close_notification?: boolean | null,
>   email_config_id?: number | null,
>   group_id?: number | null,
>   priority?: number | null,
>   parent_id?: number | null,
>   requester_id?: number | null,
>   responder_id?: number | null,
>   source?: number | null,
>   status?: number | null,
>   type?: string | null,
>   product_id?: number | null,
>   due_by?: string | null,
>   fr_due_by?: string | null,
>   custom_fields?: Record<string, JsonValue> | null,
>   tags?: string[] | null,
>   internal_agent_id?: number | null,
>   internal_group_id?: number | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### categoryAttributesDelete.run

`routes.categoryAttributesDelete.run`

Categories: DELETE /api/v2/discussions/categories/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.categoryAttributesDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### categoryAttributesGet.run

`routes.categoryAttributesGet.run`

Categories: GET /api/v2/discussions/categories/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.categoryAttributesGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### categoryAttributesGetCategories.run

`routes.categoryAttributesGetCategories.run`

Categories: GET /api/v2/discussions/categories (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.categoryAttributesGetCategories.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### categoryAttributesGetForums.run

`routes.categoryAttributesGetForums.run`

Categories: GET /api/v2/discussions/categories/\[id]/forums (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.categoryAttributesGetForums.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### categoryAttributesPostCategories.run

`routes.categoryAttributesPostCategories.run`

Categories: POST /api/v2/discussions/categories (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.categoryAttributesPostCategories.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   description?: string | null,
>   id?: number | null,
>   name?: string | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### categoryAttributesPut.run

`routes.categoryAttributesPut.run`

Categories: PUT /api/v2/discussions/categories/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.categoryAttributesPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   description?: string | null,
>   id?: number | null,
>   name?: string | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### cloneTicketFormPostClone.run

`routes.cloneTicketFormPostClone.run`

Clone a Ticket Form: POST /api/v2/ticket-forms/\[id]/clone (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.cloneTicketFormPostClone.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### commentAttributesDelete.run

`routes.commentAttributesDelete.run`

Comments: DELETE /api/v2/discussions/comments/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.commentAttributesDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### commentAttributesPostComments.run

`routes.commentAttributesPostComments.run`

Comments: POST /api/v2/discussions/topics/\[topic\_id]/comments (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.commentAttributesPostComments.run({ pathParams: { topicId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   topicId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   answer?: boolean | null,
>   body?: string | null,
>   forum_id?: number | null,
>   id?: number | null,
>   published?: boolean | null,
>   spam?: boolean | null,
>   topic_id?: number | null,
>   trash?: boolean | null,
>   user_id?: number | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### commentAttributesPut.run

`routes.commentAttributesPut.run`

Comments: PUT /api/v2/discussions/comments/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.commentAttributesPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   answer?: boolean | null,
>   body?: string | null,
>   forum_id?: number | null,
>   id?: number | null,
>   published?: boolean | null,
>   spam?: boolean | null,
>   topic_id?: number | null,
>   trash?: boolean | null,
>   user_id?: number | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createAdminGroupPostGroups.run

`routes.createAdminGroupPostGroups.run`

Create a Group: POST /api/v2/admin/groups (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createAdminGroupPostGroups.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   description?: string | null,
>   type?: string | null,
>   escalate_to?: number | null,
>   unassigned_for?: string | null,
>   agent_ids?: JsonValue[] | null,
>   business_calendar_id?: number | null,
>   allow_agents_to_change_availability?: boolean | null,
>   automatic_agent_assignment?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createAgentPostOperation.run

`routes.createAgentPostOperation.run`

Create an Agent: POST /api/v2/agents/ (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createAgentPostOperation.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   occasional?: boolean | null,
>   signature?: string | null,
>   ticket_scope?: number | null,
>   skill_ids?: number[] | null,
>   group_ids?: number[] | null,
>   role_ids?: number[] | null,
>   agent_type?: number | null,
>   email?: string | null,
>   language?: string | null,
>   time_zone?: string | null,
>   focus_mode?: boolean | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createAnAutomationRulePostRules.run

`routes.createAnAutomationRulePostRules.run`

Create an Automation Rule: POST /api/v2/automations/\[automation\_type\_id]/rules (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createAnAutomationRulePostRules.run({ pathParams: { automationTypeId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   automationTypeId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   automation_type_id?: number | null,
>   name?: string | null,
>   description?: string | null,
>   position?: number | null,
>   active?: boolean | null,
>   performer?: JsonValue,
>   events?: JsonValue[] | null,
>   conditions?: JsonValue[] | null,
>   operator?: string | null,
>   actions?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createANewCustomObjectRecordPostOperation.run

`routes.createANewCustomObjectRecordPostOperation.run`

Create A Record: POST /api/v2/custom\_objects/schemas/\[schema\_id]/records/ (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createANewCustomObjectRecordPostOperation.run({ pathParams: { schemaId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   schemaId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createAThreadPostThreads.run

`routes.createAThreadPostThreads.run`

Create a thread: POST /api/v2/collaboration/threads (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createAThreadPostThreads.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   type?: string | null,
>   parent?: Record<string, JsonValue> | null,
>   additional_info?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createCannedResponseFolderPostCannedResponseFolders.run

`routes.createCannedResponseFolderPostCannedResponseFolders.run`

Create Folder: POST /api/v2/canned\_response\_folders (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createCannedResponseFolderPostCannedResponseFolders.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createCannedResponsePostCannedResponses.run

`routes.createCannedResponsePostCannedResponses.run`

Create a canned response: POST /api/v2/canned\_responses (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createCannedResponsePostCannedResponses.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title?: string | null,
>   content_html?: string | null,
>   folder_id?: number | null,
>   visibility?: number | null,
>   group_ids?: number[] | null,
>   attachments?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createCompanyFieldPostCompanyFields.run

`routes.createCompanyFieldPostCompanyFields.run`

Create a company field: POST /api/v2/company\_fields (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createCompanyFieldPostCompanyFields.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   label?: string | null,
>   type?: string | null,
>   position?: number | null,
>   required_for_agents?: boolean | null,
>   agents_can_edit?: boolean | null,
>   displayed_for_agents?: boolean | null,
>   quick_add_for_agent?: boolean | null,
>   unique?: boolean | null,
>   choices?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createCompanyPostCompanies.run

`routes.createCompanyPostCompanies.run`

Create a Company: POST /api/v2/companies (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createCompanyPostCompanies.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   custom_fields?: Record<string, JsonValue> | null,
>   description?: string | null,
>   domains?: JsonValue[] | null,
>   name?: string | null,
>   note?: string | null,
>   health_score?: string | null,
>   account_tier?: string | null,
>   renewal_date?: string | null,
>   industry?: string | null,
>   lookup_parameter?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createContactFieldPostContactFields.run

`routes.createContactFieldPostContactFields.run`

Create a contact field: POST /api/v2/contact\_fields (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createContactFieldPostContactFields.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   label?: string | null,
>   label_for_customers?: string | null,
>   type?: string | null,
>   editable_in_signup?: boolean | null,
>   position?: number | null,
>   required_for_agents?: boolean | null,
>   agents_can_edit?: boolean | null,
>   displayed_for_agents?: boolean | null,
>   quick_add_for_agent?: boolean | null,
>   unique?: boolean | null,
>   customers_can_edit?: boolean | null,
>   required_for_customers?: boolean | null,
>   displayed_for_customers?: boolean | null,
>   choices?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createContactPostContacts.run

`routes.createContactPostContacts.run`

Create a Contact: POST /api/v2/contacts (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createContactPostContacts.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   email?: string | null,
>   phone?: string | null,
>   mobile?: string | null,
>   twitter_id?: string | null,
>   social_handler?: JsonValue[] | null,
>   unique_external_id?: string | null,
>   other_emails?: string[] | null,
>   company_id?: number | null,
>   view_all_tickets?: boolean | null,
>   other_companies?: JsonValue[] | null,
>   address?: string | null,
>   avatar?: Record<string, JsonValue> | null,
>   custom_fields?: Record<string, JsonValue> | null,
>   description?: string | null,
>   job_title?: string | null,
>   language?: string | null,
>   tags?: string[] | null,
>   time_zone?: string | null,
>   lookup_parameter?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createEmailMailboxPostMailboxes.run

`routes.createEmailMailboxPostMailboxes.run`

Create an Email Mailbox: POST /api/v2/email/mailboxes (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createEmailMailboxPostMailboxes.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   support_email?: string | null,
>   group_id?: number | null,
>   product_id?: number | null,
>   default_reply_email?: boolean | null,
>   mailbox_type?: string | null,
>   custom_mailbox?: Record<string, JsonValue> | null,
>   access_type?: string | null,
>   incoming?: Record<string, JsonValue> | null,
>   mail_server?: string | null,
>   port?: number | null,
>   use_ssl?: boolean | null,
>   delete_from_server?: boolean | null,
>   authentication?: string | null,
>   username?: string | null,
>   password?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createGroupPostGroups.run

`routes.createGroupPostGroups.run`

Create a Group: POST /api/v2/groups (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createGroupPostGroups.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   agent_ids?: JsonValue[] | null,
>   auto_ticket_assign?: number | null,
>   description?: string | null,
>   escalate_to?: number | null,
>   name?: string | null,
>   unassigned_for?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createMessageForThreadPostMessages.run

`routes.createMessageForThreadPostMessages.run`

Create message for thread: POST /api/v2/collaboration/messages (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.createMessageForThreadPostMessages.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   body?: string | null,
>   participants?: Record<string, JsonValue> | null,
>   additional_info?: Record<string, JsonValue> | null,
>   thread_id?: string | null,
>   attachment_ids?: string[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createMultipleAgentsPostBulk.run

`routes.createMultipleAgentsPostBulk.run`

Create Multiple Agents: POST /api/v2/agents/bulk (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createMultipleAgentsPostBulk.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   occasional?: boolean | null,
>   signature?: string | null,
>   ticket_scope?: number | null,
>   skill_ids?: number[] | null,
>   group_ids?: number[] | null,
>   role_ids?: number[] | null,
>   name?: string | null,
>   email?: string | null,
>   phone?: string | null,
>   mobile?: string | null,
>   job_title?: string | null,
>   language?: string | null,
>   time_zone?: string | null,
>   focus_mode?: boolean | null,
>   agents?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createOutboundEmailPostOutboundEmail.run

`routes.createOutboundEmailPostOutboundEmail.run`

Create an Outbound Email: POST /api/v2/tickets/outbound\_email (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.createOutboundEmailPostOutboundEmail.run({ body: { email: 'customer@example.com', subject: 'Following up on your request', description: 'Details of the follow-up', email_config_id: 1 } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | Yes | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   email: string,
>   subject: string,
>   type?: string | null,
>   status?: number | null,
>   priority?: number | null,
>   description?: string | null,
>   attachments?: JsonValue[] | null,
>   custom_fields?: Record<string, JsonValue> | null,
>   due_by?: string | null,
>   email_config_id: number,
>   fr_due_by?: string | null,
>   group_id?: number | null,
>   tags?: string[] | null,
>   cc_emails?: string[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createSatisfactionRatingPostSatisfactionRatings.run

`routes.createSatisfactionRatingPostSatisfactionRatings.run`

Create a Satisfaction Rating: POST /api/v2/tickets/\[ticket\_id]/satisfaction\_ratings (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createSatisfactionRatingPostSatisfactionRatings.run({ pathParams: { ticketId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   ticketId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   feedback?: string | null,
>   ratings?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createSectionPostSections.run

`routes.createSectionPostSections.run`

Create a Section: POST /api/v2/admin/ticket\_fields/\[id]/sections (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createSectionPostSections.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   label?: string | null,
>   choice_ids?: number[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createSkillPostSkills.run

`routes.createSkillPostSkills.run`

Create a Skill: POST /api/v2/admin/skills (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createSkillPostSkills.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   agents?: JsonValue[] | null,
>   match_type?: string | null,
>   conditions?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createSlaPolicyPostSlaPolicies.run

`routes.createSlaPolicyPostSlaPolicies.run`

Create SLA Policies: POST /api/v2/sla\_policies (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createSlaPolicyPostSlaPolicies.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   sla_target?: Record<string, JsonValue> | null,
>   applicable_to?: Record<string, JsonValue> | null,
>   description?: string | null,
>   active?: boolean | null,
>   is_default?: boolean | null,
>   position?: number | null,
>   escalation?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createSurveyResponsesPostResponses.run

`routes.createSurveyResponsesPostResponses.run`

Create a Survey Response: POST /api/v2/customer-satisfaction/surveys/\[survey\_id]/responses (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createSurveyResponsesPostResponses.run({ pathParams: { surveyId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   surveyId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   survey_id?: string | null,
>   ticket_id?: number | null,
>   answers?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createTicketFieldPostTicketFields.run

`routes.createTicketFieldPostTicketFields.run`

Create a Ticket Field: POST /api/v2/admin/ticket\_fields (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createTicketFieldPostTicketFields.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customers_can_edit?: boolean | null,
>   label_for_customers?: string | null,
>   displayed_to_customers?: boolean | null,
>   label?: string | null,
>   type?: string | null,
>   position?: number | null,
>   required_for_closure?: boolean | null,
>   required_for_agents?: boolean | null,
>   required_for_customers?: boolean | null,
>   choices?: JsonValue[] | null,
>   dependent_fields?: JsonValue[] | null,
>   section_mappings?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createTicketFormPostTicketForms.run

`routes.createTicketFormPostTicketForms.run`

Create a Ticket Form: POST /api/v2/ticket-forms (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createTicketFormPostTicketForms.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title?: string | null,
>   description?: string | null,
>   fields?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createTicketPostTickets.run

`routes.createTicketPostTickets.run`

Create a Ticket: POST /api/v2/tickets (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createTicketPostTickets.run({ body: { email: 'customer@example.com', subject: 'Cannot log in', description: 'Details of the issue', status: 2, priority: 1 } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   requester_id?: number | null,
>   email?: string | null,
>   facebook_id?: string | null,
>   phone?: string | null,
>   twitter_id?: string | null,
>   unique_external_id?: string | null,
>   subject?: string | null,
>   type?: string | null,
>   status?: number | null,
>   priority?: number | null,
>   description?: string | null,
>   responder_id?: number | null,
>   attachments?: JsonValue[] | null,
>   cc_emails?: string[] | null,
>   custom_fields?: Record<string, JsonValue> | null,
>   due_by?: string | null,
>   email_config_id?: number | null,
>   fr_due_by?: string | null,
>   group_id?: number | null,
>   parent_id?: number | null,
>   product_id?: number | null,
>   source?: number | null,
>   tags?: string[] | null,
>   company_id?: number | null,
>   internal_agent_id?: number | null,
>   internal_group_id?: number | null,
>   lookup_parameter?: string | null,
>   related_ticket_ids?: number[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### createTimeEntryPostTimeEntries.run

`routes.createTimeEntryPostTimeEntries.run`

Create a Time Entry: POST /api/v2/tickets/\[ticket\_id]/time\_entries (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.createTimeEntryPostTimeEntries.run({ pathParams: { ticketId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   ticketId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   agent_id?: number | null,
>   billable?: boolean | null,
>   executed_at?: string | null,
>   note?: string | null,
>   start_time?: string | null,
>   time_spent?: string | null,
>   timer_running?: boolean | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### csatSurveysGetSurveys.run

`routes.csatSurveysGetSurveys.run`

Surveys: GET /api/v2/customer-satisfaction/surveys (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.csatSurveysGetSurveys.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteACustomObjectRecordDeleteRecordId.run

`routes.deleteACustomObjectRecordDeleteRecordId.run`

Delete A Record: DELETE /api/v2/custom\_objects/schemas/\[schema\_id]/records/\[record\_id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteACustomObjectRecordDeleteRecordId.run({ pathParams: { schemaId: '123', recordId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   schemaId: string,
>   recordId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   display_id?: string | null,
>   data?: Record<string, JsonValue> | null,
>   version?: number | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteAdminGroupDelete.run

`routes.deleteAdminGroupDelete.run`

Delete a Group: DELETE /api/v2/admin/groups/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteAdminGroupDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteAgentDelete.run

`routes.deleteAgentDelete.run`

Delete an Agent: DELETE /api/v2/agents/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteAgentDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteAnAttachmentDelete.run

`routes.deleteAnAttachmentDelete.run`

Delete an attachment: DELETE /api/v2/attachments/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteAnAttachmentDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteAnAutomationRuleDelete.run

`routes.deleteAnAutomationRuleDelete.run`

Delete an Automation Rule: DELETE /api/v2/automations/\[automation\_type\_id]/rules/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteAnAutomationRuleDelete.run({ pathParams: { automationTypeId: '123', id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   automationTypeId: string,
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteAThreadDelete.run

`routes.deleteAThreadDelete.run`

Delete a thread: DELETE /api/v2/collaboration/threads/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteAThreadDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteATicketDelete.run

`routes.deleteATicketDelete.run`

Delete a Ticket: DELETE /api/v2/tickets/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteATicketDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteCompanyDelete.run

`routes.deleteCompanyDelete.run`

Delete a Company: DELETE /api/v2/companies/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteCompanyDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteCompanyFieldDelete.run

`routes.deleteCompanyFieldDelete.run`

Delete a company field: DELETE /api/v2/company\_fields/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteCompanyFieldDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteContactDelete.run

`routes.deleteContactDelete.run`

Soft Delete a Contact: DELETE /api/v2/contacts/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteContactDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteContactFieldDelete.run

`routes.deleteContactFieldDelete.run`

Delete a contact field: DELETE /api/v2/contact\_fields/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteContactFieldDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteConversationDelete.run

`routes.deleteConversationDelete.run`

Delete a conversation: DELETE /api/v2/conversations/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteConversationDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteEmailMailboxDelete.run

`routes.deleteEmailMailboxDelete.run`

Delete an Email Mailbox: DELETE /api/v2/email/mailboxes/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteEmailMailboxDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteGroupDelete.run

`routes.deleteGroupDelete.run`

Delete a Group: DELETE /api/v2/groups/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteGroupDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteMessageForThreadDelete.run

`routes.deleteMessageForThreadDelete.run`

Delete message for thread: DELETE /api/v2/collaboration/messages/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteMessageForThreadDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteSectionDeleteSectionId.run

`routes.deleteSectionDeleteSectionId.run`

Delete a section: DELETE /api/v2/admin/ticket\_fields/\[id]/sections/\[section\_id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteSectionDeleteSectionId.run({ pathParams: { id: '123', sectionId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   sectionId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteSkillDelete.run

`routes.deleteSkillDelete.run`

Delete a Skill: DELETE /api/v2/admin/skills/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteSkillDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteTicketFieldDelete.run

`routes.deleteTicketFieldDelete.run`

Delete a Ticket Field: DELETE /api/v2/admin/ticket\_fields/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteTicketFieldDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteTicketFormDelete.run

`routes.deleteTicketFormDelete.run`

Delete a Ticket Form: DELETE /api/v2/ticket-forms/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteTicketFormDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteTicketFormFieldDeleteFieldId.run

`routes.deleteTicketFormFieldDeleteFieldId.run`

Delete a Ticket Form's Field: DELETE /api/v2/ticket-forms/\[form-id]/fields/\[field-id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteTicketFormFieldDeleteFieldId.run({ pathParams: { formId: '123', fieldId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   formId: string,
>   fieldId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### deleteTimeEntryDelete.run

`routes.deleteTimeEntryDelete.run`

Delete a Time Entry: DELETE /api/v2/time\_entries/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.deleteTimeEntryDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### exportAuditLogGet.run

`routes.exportAuditLogGet.run`

Export Audit Logs: GET /api/v2/audit\_log/export/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.exportAuditLogGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### exportAuditLogPostExport.run

`routes.exportAuditLogPostExport.run`

Export Audit Logs: POST /api/v2/audit\_log/export (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.exportAuditLogPostExport.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   from?: string | null,
>   to?: string | null,
>   export_format?: string | null,
>   receive_via?: string | null,
>   filter?: Record<string, JsonValue> | null,
>   condition?: string | null,
>   archived?: boolean | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### exportCompanyGet.run

`routes.exportCompanyGet.run`

Company Export: GET /api/v2/companies/export/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.exportCompanyGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### exportCompanyPostExport.run

`routes.exportCompanyPostExport.run`

Company Export: POST /api/v2/companies/export (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.exportCompanyPostExport.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fields?: Record<string, JsonValue> | null,
>   default_fields?: Record<string, JsonValue> | null,
>   custom_fields?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### exportContactGet.run

`routes.exportContactGet.run`

Contact Export: GET /api/v2/contacts/export/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.exportContactGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### exportContactPostExport.run

`routes.exportContactPostExport.run`

Contact Export: POST /api/v2/contacts/export (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.exportContactPostExport.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fields?: Record<string, JsonValue> | null,
>   default_fields?: Record<string, JsonValue> | null,
>   custom_fields?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### filterCompaniesGetCompanies.run

`routes.filterCompaniesGetCompanies.run`

Filter CompaniesBETA: GET /api/v2/search/companies (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.filterCompaniesGetCompanies.run({ query: { query: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   query: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### filterContactsGetContacts.run

`routes.filterContactsGetContacts.run`

Filter ContactsBETA: GET /api/v2/search/contacts (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.filterContactsGetContacts.run({ query: { query: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   query: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### filterTicketsGetTickets.run

`routes.filterTicketsGetTickets.run`

Filter Tickets: GET /api/v2/search/tickets (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.filterTicketsGetTickets.run({ query: { query: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   query: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### forumAttributesDelete.run

`routes.forumAttributesDelete.run`

Forums: DELETE /api/v2/discussions/forums/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.forumAttributesDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### forumAttributesDeleteFollow\.run

`routes.forumAttributesDeleteFollow.run`

Forums: DELETE /api/v2/discussions/forums/\[forum\_id]/follow (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.forumAttributesDeleteFollow.run({ pathParams: { forumId: '123' }, query: { user_id: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   forumId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   user_id: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### forumAttributesGet.run

`routes.forumAttributesGet.run`

Forums: GET /api/v2/discussions/forums/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.forumAttributesGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### forumAttributesGetFollow\.run

`routes.forumAttributesGetFollow.run`

Forums: GET /api/v2/discussions/forums/\[id]/follow (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.forumAttributesGetFollow.run({ pathParams: { id: '123' }, query: { user_id: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   user_id: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### forumAttributesGetTopics.run

`routes.forumAttributesGetTopics.run`

Forums: GET /api/v2/discussions/forums/\[id]/topics (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.forumAttributesGetTopics.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### forumAttributesPostFollow\.run

`routes.forumAttributesPostFollow.run`

Forums: POST /api/v2/discussions/forums/\[id]/follow (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.forumAttributesPostFollow.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   company_ids?: number[] | null,
>   description?: string | null,
>   forum_category_id?: number | null,
>   forum_type?: number | null,
>   forum_visibility?: number | null,
>   id?: number | null,
>   name?: string | null,
>   position?: number | null,
>   posts_count?: number | null,
>   topics_count?: number | null,
>   user_id?: number | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### forumAttributesPostForums.run

`routes.forumAttributesPostForums.run`

Forums: POST /api/v2/discussions/categories/\[category\_id]/forums (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.forumAttributesPostForums.run({ pathParams: { categoryId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   categoryId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   company_ids?: number[] | null,
>   description?: string | null,
>   forum_category_id?: number | null,
>   forum_type?: number | null,
>   forum_visibility?: number | null,
>   id?: number | null,
>   name?: string | null,
>   position?: number | null,
>   posts_count?: number | null,
>   topics_count?: number | null,
>   user_id?: number | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### forumAttributesPut.run

`routes.forumAttributesPut.run`

Forums: PUT /api/v2/discussions/forums/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.forumAttributesPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   company_ids?: number[] | null,
>   description?: string | null,
>   forum_category_id?: number | null,
>   forum_type?: number | null,
>   forum_visibility?: number | null,
>   id?: number | null,
>   name?: string | null,
>   position?: number | null,
>   posts_count?: number | null,
>   topics_count?: number | null,
>   user_id?: number | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### forwardTicketsPostForward.run

`routes.forwardTicketsPostForward.run`

Forward a ticket: POST /api/v2/tickets/\[id]/forward (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.forwardTicketsPostForward.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   body?: string | null,
>   body_text?: string | null,
>   id?: number | null,
>   incoming?: boolean | null,
>   private?: boolean | null,
>   agent_id?: number | null,
>   support_email?: string | null,
>   source?: number | null,
>   ticket_id?: number | null,
>   include_quoted_text?: boolean | null,
>   include_original_attachments?: boolean | null,
>   from_email?: string | null,
>   to_emails?: string[] | null,
>   cc_emails?: string[] | null,
>   bcc_emails?: string[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### generateExportPostExport.run

`routes.generateExportPostExport.run`

Export Account: POST /api/v2/account/export (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.generateExportPostExport.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   date_range?: Record<string, JsonValue> | null,
>   resources?: JsonValue[] | null,
>   output_format?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### getAThreadGet.run

`routes.getAThreadGet.run`

Get a thread: GET /api/v2/collaboration/threads/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.getAThreadGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### getDetailsOfCannedResponsesInFoldersGetResponses.run

`routes.getDetailsOfCannedResponsesInFoldersGetResponses.run`

Get details of Canned Responses in a Folder: GET /api/v2/canned\_response\_folders/\[id]/responses (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.getDetailsOfCannedResponsesInFoldersGetResponses.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### getMessageForThreadGet.run

`routes.getMessageForThreadGet.run`

Get message for thread: GET /api/v2/collaboration/messages/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.getMessageForThreadGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### getQuotedTextGetGenerateQuote.run

`routes.getQuotedTextGetGenerateQuote.run`

Get quoted text for message: GET /api/v2/collaboration/messages/\[id]/generate-quote (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.getQuotedTextGetGenerateQuote.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### hardDeleteContactDeleteHardDelete.run

`routes.hardDeleteContactDeleteHardDelete.run`

Permanently Delete a Contact: DELETE /api/v2/contacts/\[id]/hard\_delete (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.hardDeleteContactDeleteHardDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### importCompanyGet.run

`routes.importCompanyGet.run`

Company Import: GET /api/v2/companies/imports/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.importCompanyGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### importCompanyGetImports.run

`routes.importCompanyGetImports.run`

Company Import: GET /api/v2/companies/imports (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.importCompanyGetImports.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### importCompanyPostImports.run

`routes.importCompanyPostImports.run`

Company Import: POST /api/v2/companies/imports (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.importCompanyPostImports.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fields?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### importCompanyPutCancel.run

`routes.importCompanyPutCancel.run`

Company Import: PUT /api/v2/companies/imports/\[id]/cancel (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.importCompanyPutCancel.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   file?: Record<string, JsonValue> | null,
>   fields?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### importContactGet.run

`routes.importContactGet.run`

Contact Import: GET /api/v2/contacts/imports/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.importContactGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### importContactGetImports.run

`routes.importContactGetImports.run`

Contact Import: GET /api/v2/contacts/imports (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.importContactGetImports.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### importContactPostImports.run

`routes.importContactPostImports.run`

Contact Import: POST /api/v2/contacts/imports (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.importContactPostImports.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fields?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### importContactPutCancel.run

`routes.importContactPutCancel.run`

Contact Import: PUT /api/v2/contacts/imports/\[id]/cancel (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.importContactPutCancel.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   file?: Record<string, JsonValue> | null,
>   fields?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllAdminGroupsGetGroups.run

`routes.listAllAdminGroupsGetGroups.run`

List All Groups: GET /api/v2/admin/groups (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllAdminGroupsGetGroups.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllAgentsAvailabilityGetAgents.run

`routes.listAllAgentsAvailabilityGetAgents.run`

List All Agents Availability: GET /api/v2/agents (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllAgentsAvailabilityGetAgents.run({ query: { only: 'availability' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllAgentsGetAgents.run

`routes.listAllAgentsGetAgents.run`

List All Agents: GET /api/v2/agents (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllAgentsGetAgents.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllAgentsInAGroupGetAgents.run

`routes.listAllAgentsInAGroupGetAgents.run`

List All Agents in a Group: GET /api/v2/admin/groups/\[id]/agents (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllAgentsInAGroupGetAgents.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllAutomationRulesGetRules.run

`routes.listAllAutomationRulesGetRules.run`

List All Automation Rules: GET /api/v2/automations/\[automation\_type\_id]/rules (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllAutomationRulesGetRules.run({ pathParams: { automationTypeId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   automationTypeId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllBusinessHoursGetBusinessHours.run

`routes.listAllBusinessHoursGetBusinessHours.run`

List All Business Hours: GET /api/v2/business\_hours (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllBusinessHoursGetBusinessHours.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllCannedResponseFoldersGetCannedResponseFolders.run

`routes.listAllCannedResponseFoldersGetCannedResponseFolders.run`

List All Folders: GET /api/v2/canned\_response\_folders (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllCannedResponseFoldersGetCannedResponseFolders.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllCompaniesGetCompanies.run

`routes.listAllCompaniesGetCompanies.run`

List All Companies: GET /api/v2/companies (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllCompaniesGetCompanies.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllCompanyFieldsGetCompanyFields.run

`routes.listAllCompanyFieldsGetCompanyFields.run`

List all company fields: GET /api/v2/company\_fields (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllCompanyFieldsGetCompanyFields.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllContactFieldsGetContactFields.run

`routes.listAllContactFieldsGetContactFields.run`

List all contact fields: GET /api/v2/contact\_fields (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllContactFieldsGetContactFields.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllContactsGetContacts.run

`routes.listAllContactsGetContacts.run`

List All Contacts: GET /api/v2/contacts (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllContactsGetContacts.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllEmailConfigsGetEmailConfigs.run

`routes.listAllEmailConfigsGetEmailConfigs.run`

List All Email Configs: GET /api/v2/email\_configs (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllEmailConfigsGetEmailConfigs.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllEmailMailboxesGetMailboxes.run

`routes.listAllEmailMailboxesGetMailboxes.run`

List All Email Mailboxes: GET /api/v2/email/mailboxes (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllEmailMailboxesGetMailboxes.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllGroupsGetGroups.run

`routes.listAllGroupsGetGroups.run`

List All Groups: GET /api/v2/groups (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllGroupsGetGroups.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllProductsGetProducts.run

`routes.listAllProductsGetProducts.run`

List All Products: GET /api/v2/products (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllProductsGetProducts.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllRolesGetRoles.run

`routes.listAllRolesGetRoles.run`

List All Roles: GET /api/v2/roles (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllRolesGetRoles.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllScenarioAutomationsGetScenarioAutomations.run

`routes.listAllScenarioAutomationsGetScenarioAutomations.run`

List All Scenario Automations: GET /api/v2/scenario\_automations (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllScenarioAutomationsGetScenarioAutomations.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllSectionFieldsGetSections.run

`routes.listAllSectionFieldsGetSections.run`

List All Sections for a Ticket Field: GET /api/v2/admin/ticket\_fields/\[id]/sections (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllSectionFieldsGetSections.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllSkillsGetOperation.run

`routes.listAllSkillsGetOperation.run`

List all Skills: GET /api/v2/admin/skills/ (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllSkillsGetOperation.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllSlaPoliciesGetSlaPolicies.run

`routes.listAllSlaPoliciesGetSlaPolicies.run`

List All SLA Policies: GET /api/v2/sla\_policies (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllSlaPoliciesGetSlaPolicies.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllSurveyGetSurveys.run

`routes.listAllSurveyGetSurveys.run`

List all Surveys: GET /api/v2/surveys (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllSurveyGetSurveys.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllTicketFieldsGetTicketFields.run

`routes.listAllTicketFieldsGetTicketFields.run`

List All Ticket Fields: GET /api/v2/ticket\_fields (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllTicketFieldsGetTicketFields.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllTicketFieldsGetTicketFields35.run

`routes.listAllTicketFieldsGetTicketFields35.run`

List All Ticket Fields: GET /api/v2/admin/ticket\_fields (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllTicketFieldsGetTicketFields35.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllTicketFormsGetTicketForms.run

`routes.listAllTicketFormsGetTicketForms.run`

List All Ticket Forms: GET /api/v2/ticket-forms (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllTicketFormsGetTicketForms.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllTicketNotesGetConversations.run

`routes.listAllTicketNotesGetConversations.run`

List All Conversations of a Ticket: GET /api/v2/tickets/\[id]/conversations (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllTicketNotesGetConversations.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllTicketsGetTickets.run

`routes.listAllTicketsGetTickets.run`

List All Tickets: GET /api/v2/tickets (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllTicketsGetTickets.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllTicketTimeentriesGetTimeEntries.run

`routes.listAllTicketTimeentriesGetTimeEntries.run`

List All Time Entries of a Ticket: GET /api/v2/tickets/\[id]/time\_entries (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllTicketTimeentriesGetTimeEntries.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listAllTimeEntriesGetTimeEntries.run

`routes.listAllTimeEntriesGetTimeEntries.run`

List All Time Entries: GET /api/v2/time\_entries (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listAllTimeEntriesGetTimeEntries.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### listSpecificSectionGetSectionId.run

`routes.listSpecificSectionGetSectionId.run`

List a specific Section details: GET /api/v2/admin/ticket\_fields/\[id]/sections/\[section\_id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.listSpecificSectionGetSectionId.run({ pathParams: { id: '123', sectionId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   sectionId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### makeAgentPutMakeAgent.run

`routes.makeAgentPutMakeAgent.run`

Make Agent: PUT /api/v2/contacts/\[id]/make\_agent (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.makeAgentPutMakeAgent.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   occasional?: boolean | null,
>   signature?: string | null,
>   ticket_scope?: number | null,
>   skill_ids?: number[] | null,
>   group_ids?: number[] | null,
>   role_ids?: number[] | null,
>   type?: string | null,
>   focus_mode?: boolean | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### meGetMe.run

`routes.meGetMe.run`

Currently Authenticated Agent: GET /api/v2/agents/me (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.meGetMe.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### mergeContactPostMerge.run

`routes.mergeContactPostMerge.run`

Merge Contacts: POST /api/v2/contacts/merge (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.mergeContactPostMerge.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   primary_contact_id?: number | null,
>   secondary_contact_ids?: number[] | null,
>   contact?: Record<string, JsonValue> | null,
>   email?: string | null,
>   phone?: string | null,
>   mobile?: string | null,
>   twitter_id?: string | null,
>   unique_external_id?: string | null,
>   other_emails?: string[] | null,
>   company_ids?: number[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### publishOmnichannelActivityPostContactActivities.run

`routes.publishOmnichannelActivityPostContactActivities.run`

Publish Activities: POST /api/v2/contact-activities (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.publishOmnichannelActivityPostContactActivities.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   activity?: Record<string, JsonValue> | null,
>   contact?: Record<string, JsonValue> | null,
>   id?: string | null,
>   type?: string | null,
>   name?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### replyTicketPostReply.run

`routes.replyTicketPostReply.run`

Create a Reply: POST /api/v2/tickets/\[id]/reply (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.replyTicketPostReply.run({ pathParams: { id: '123' }, body: { body: 'Thanks, this is fixed now.' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   body?: string | null,
>   structured_body?: Record<string, JsonValue> | null,
>   attachments?: JsonValue[] | null,
>   from_email?: string | null,
>   user_id?: number | null,
>   cc_emails?: string[] | null,
>   bcc_emails?: string[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### replyToForwardPostReplyToForward.run

`routes.replyToForwardPostReplyToForward.run`

Reply to Forward: POST /api/v2/tickets/\[id]/reply\_to\_forward (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.replyToForwardPostReplyToForward.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   body?: string | null,
>   body_text?: string | null,
>   user_id?: number | null,
>   ticket_id?: number | null,
>   to_emails?: string[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### restoreATicketPutRestore.run

`routes.restoreATicketPutRestore.run`

Restore a Ticket: PUT /api/v2/tickets/\[id]/restore (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.restoreATicketPutRestore.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### restoreContactPutRestore.run

`routes.restoreContactPutRestore.run`

Restore a Contact: PUT /api/v2/contacts/\[id]/restore (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.restoreContactPutRestore.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### retrieveACustomObjectRecordGetRecordId.run

`routes.retrieveACustomObjectRecordGetRecordId.run`

Retrieve A Record: GET /api/v2/custom\_objects/schemas/\[schema\_id]/records/\[record\_id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.retrieveACustomObjectRecordGetRecordId.run({ pathParams: { schemaId: '123', recordId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   schemaId: string,
>   recordId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### retrieveAllTheRecordsOfACustomObjectGetRecords.run

`routes.retrieveAllTheRecordsOfACustomObjectGetRecords.run`

Retrieve All Records: GET /api/v2/custom\_objects/schemas/\[schema\_id]/records (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.retrieveAllTheRecordsOfACustomObjectGetRecords.run({ pathParams: { schemaId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   schemaId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### retrieveExistingCustomObjectsGetSchemas.run

`routes.retrieveExistingCustomObjectsGetSchemas.run`

Retrieve Existing Custom Objects: GET /api/v2/custom\_objects/schemas (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.retrieveExistingCustomObjectsGetSchemas.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### retrieveOutboundMessageGetMessageId.run

`routes.retrieveOutboundMessageGetMessageId.run`

Retrieve Message: GET /api/v2/channels/outbound-messages/\[message-id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.retrieveOutboundMessageGetMessageId.run({ pathParams: { messageId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   messageId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### retrieveSpecificCustomObjectGetSchemaId.run

`routes.retrieveSpecificCustomObjectGetSchemaId.run`

Retrieve A Specific Custom Object: GET /api/v2/custom\_objects/schemas/\[schema\_id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.retrieveSpecificCustomObjectGetSchemaId.run({ pathParams: { schemaId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   schemaId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### retrieveTheCountOfRecordsCustomObjectsGetCount.run

`routes.retrieveTheCountOfRecordsCustomObjectsGetCount.run`

Retrieve The Count Of Records: GET /api/v2/custom\_objects/schemas/\[schema\_id]/records/count (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.retrieveTheCountOfRecordsCustomObjectsGetCount.run({ pathParams: { schemaId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   schemaId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### searchAgentsGetAutocomplete.run

`routes.searchAgentsGetAutocomplete.run`

Search Agents: GET /api/v2/agents/autocomplete (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.searchAgentsGetAutocomplete.run({ query: { term: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   term: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### searchCompaniesGetAutocomplete.run

`routes.searchCompaniesGetAutocomplete.run`

Search Companies: GET /api/v2/companies/autocomplete (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.searchCompaniesGetAutocomplete.run({ query: { name: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   name: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### searchContactsGetAutocomplete.run

`routes.searchContactsGetAutocomplete.run`

Search Contacts: GET /api/v2/contacts/autocomplete (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.searchContactsGetAutocomplete.run({ query: { term: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   term: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### sendInvitePutSendInvite.run

`routes.sendInvitePutSendInvite.run`

Send Invite to a Contact: PUT /api/v2/contacts/\[id]/send\_invite (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.sendInvitePutSendInvite.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### sendOutboundMessagePostOutboundMessages.run

`routes.sendOutboundMessagePostOutboundMessages.run`

Send Proactive Message: POST /api/v2/channels/outbound-messages (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.sendOutboundMessagePostOutboundMessages.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   from?: Record<string, JsonValue> | null,
>   to?: Record<string, JsonValue> | null,
>   channel_type?: string | null,
>   message?: Record<string, JsonValue> | null,
>   external_reference_id?: string | null,
>   note_policy?: Record<string, JsonValue> | null,
>   note?: Record<string, JsonValue> | null,
>   ticket_properties?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### settingsHelpdeskGetHelpdesk.run

`routes.settingsHelpdeskGetHelpdesk.run`

View Helpdesk Settings: GET /api/v2/settings/helpdesk (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.settingsHelpdeskGetHelpdesk.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionArticleAttributesDelete.run

`routes.solutionArticleAttributesDelete.run`

Articles: DELETE /api/v2/solutions/articles/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionArticleAttributesDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionArticleAttributesGet.run

`routes.solutionArticleAttributesGet.run`

Articles: GET /api/v2/solutions/articles/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionArticleAttributesGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionArticleAttributesGetArticles.run

`routes.solutionArticleAttributesGetArticles.run`

Articles: GET /api/v2/solutions/folders/\[id]/articles (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionArticleAttributesGetArticles.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionArticleAttributesGetLanguageCode.run

`routes.solutionArticleAttributesGetLanguageCode.run`

Articles: GET /api/v2/solutions/articles/\[id]/\[language\_code] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionArticleAttributesGetLanguageCode.run({ pathParams: { id: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionArticleAttributesGetLanguageCode206.run

`routes.solutionArticleAttributesGetLanguageCode206.run`

Articles: GET /api/v2/solutions/folders/\[id]/articles/\[language\_code] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionArticleAttributesGetLanguageCode206.run({ pathParams: { id: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionArticleAttributesGetSolutions.run

`routes.solutionArticleAttributesGetSolutions.run`

Articles: GET /api/v2/search/solutions (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionArticleAttributesGetSolutions.run({ query: { term: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   term: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionArticleAttributesPostArticles.run

`routes.solutionArticleAttributesPostArticles.run`

Articles: POST /api/v2/solutions/folders/\[id]/articles (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionArticleAttributesPostArticles.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   agent_id?: number | null,
>   category_id?: number | null,
>   description?: string | null,
>   description_text?: string | null,
>   folder_id?: number | null,
>   hierarchy?: JsonValue[] | null,
>   hits?: number | null,
>   status?: number | null,
>   seo_data?: Record<string, JsonValue> | null,
>   tags?: string[] | null,
>   thumbs_down?: number | null,
>   thumbs_up?: number | null,
>   title?: string | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionArticleAttributesPostLanguageCode.run

`routes.solutionArticleAttributesPostLanguageCode.run`

Articles: POST /api/v2/solutions/articles/\[id]/\[language\_code] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionArticleAttributesPostLanguageCode.run({ pathParams: { id: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   agent_id?: number | null,
>   category_id?: number | null,
>   description?: string | null,
>   description_text?: string | null,
>   folder_id?: number | null,
>   hierarchy?: JsonValue[] | null,
>   hits?: number | null,
>   status?: number | null,
>   seo_data?: Record<string, JsonValue> | null,
>   tags?: string[] | null,
>   thumbs_down?: number | null,
>   thumbs_up?: number | null,
>   title?: string | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionArticleAttributesPut.run

`routes.solutionArticleAttributesPut.run`

Articles: PUT /api/v2/solutions/articles/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionArticleAttributesPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   agent_id?: number | null,
>   category_id?: number | null,
>   description?: string | null,
>   description_text?: string | null,
>   folder_id?: number | null,
>   hierarchy?: JsonValue[] | null,
>   hits?: number | null,
>   status?: number | null,
>   seo_data?: Record<string, JsonValue> | null,
>   tags?: string[] | null,
>   thumbs_down?: number | null,
>   thumbs_up?: number | null,
>   title?: string | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionArticleAttributesPutLanguageCode.run

`routes.solutionArticleAttributesPutLanguageCode.run`

Articles: PUT /api/v2/solutions/articles/\[id]/\[language\_code] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionArticleAttributesPutLanguageCode.run({ pathParams: { id: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   agent_id?: number | null,
>   category_id?: number | null,
>   description?: string | null,
>   description_text?: string | null,
>   folder_id?: number | null,
>   hierarchy?: JsonValue[] | null,
>   hits?: number | null,
>   status?: number | null,
>   seo_data?: Record<string, JsonValue> | null,
>   tags?: string[] | null,
>   thumbs_down?: number | null,
>   thumbs_up?: number | null,
>   title?: string | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionCategoryAttributesDelete.run

`routes.solutionCategoryAttributesDelete.run`

Categories: DELETE /api/v2/solutions/categories/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionCategoryAttributesDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionCategoryAttributesGet.run

`routes.solutionCategoryAttributesGet.run`

Categories: GET /api/v2/solutions/categories/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionCategoryAttributesGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionCategoryAttributesGetCategories.run

`routes.solutionCategoryAttributesGetCategories.run`

Categories: GET /api/v2/solutions/categories (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionCategoryAttributesGetCategories.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionCategoryAttributesGetLanguageCode.run

`routes.solutionCategoryAttributesGetLanguageCode.run`

Categories: GET /api/v2/solutions/categories/\[id]/\[language\_code] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionCategoryAttributesGetLanguageCode.run({ pathParams: { id: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionCategoryAttributesGetLanguageCode186.run

`routes.solutionCategoryAttributesGetLanguageCode186.run`

Categories: GET /api/v2/solutions/categories/\[language\_code] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionCategoryAttributesGetLanguageCode186.run({ pathParams: { languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionCategoryAttributesPostCategories.run

`routes.solutionCategoryAttributesPostCategories.run`

Categories: POST /api/v2/solutions/categories (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionCategoryAttributesPostCategories.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   name?: string | null,
>   description?: string | null,
>   visible_in_portals?: number[] | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionCategoryAttributesPostLanguageCode.run

`routes.solutionCategoryAttributesPostLanguageCode.run`

Categories: POST /api/v2/solutions/categories/\[id]/\[language\_code] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionCategoryAttributesPostLanguageCode.run({ pathParams: { id: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   name?: string | null,
>   description?: string | null,
>   visible_in_portals?: number[] | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionCategoryAttributesPut.run

`routes.solutionCategoryAttributesPut.run`

Categories: PUT /api/v2/solutions/categories/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionCategoryAttributesPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   name?: string | null,
>   description?: string | null,
>   visible_in_portals?: number[] | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionCategoryAttributesPutLanguageCode.run

`routes.solutionCategoryAttributesPutLanguageCode.run`

Categories: PUT /api/v2/solutions/categories/\[id]/\[language\_code] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionCategoryAttributesPutLanguageCode.run({ pathParams: { id: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   name?: string | null,
>   description?: string | null,
>   visible_in_portals?: number[] | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesDelete.run

`routes.solutionFolderAttributesDelete.run`

Folders: DELETE /api/v2/solutions/folders/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesGet.run

`routes.solutionFolderAttributesGet.run`

Folders: GET /api/v2/solutions/folders/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesGetFolders.run

`routes.solutionFolderAttributesGetFolders.run`

Folders: GET /api/v2/solutions/categories/\[category\_id]/folders (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesGetFolders.run({ pathParams: { categoryId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   categoryId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesGetLanguageCode.run

`routes.solutionFolderAttributesGetLanguageCode.run`

Folders: GET /api/v2/solutions/folders/\[id]/\[language\_code] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesGetLanguageCode.run({ pathParams: { id: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesGetLanguageCode195.run

`routes.solutionFolderAttributesGetLanguageCode195.run`

Folders: GET /api/v2/solutions/categories/\[category\_id]/folders/\[language\_code] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesGetLanguageCode195.run({ pathParams: { categoryId: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   categoryId: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesGetLanguageCode197.run

`routes.solutionFolderAttributesGetLanguageCode197.run`

Folders: GET /api/v2/solutions/folders/\[folder\_id]/subfolders/\[language\_code] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesGetLanguageCode197.run({ pathParams: { folderId: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   folderId: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesGetSubfolders.run

`routes.solutionFolderAttributesGetSubfolders.run`

Folders: GET /api/v2/solutions/folders/\[folder\_id]/subfolders (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesGetSubfolders.run({ pathParams: { folderId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   folderId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesPostFolders.run

`routes.solutionFolderAttributesPostFolders.run`

Folders: POST /api/v2/solutions/categories/\[id]/folders (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesPostFolders.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   name?: string | null,
>   description?: string | null,
>   parent_folder_id?: number | null,
>   hierarchy?: JsonValue[] | null,
>   articles_count?: number | null,
>   sub_folders_count?: number | null,
>   visibility?: number | null,
>   company_ids?: number[] | null,
>   contact_segment_ids?: number[] | null,
>   company_segment_ids?: number[] | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesPostLanguageCode.run

`routes.solutionFolderAttributesPostLanguageCode.run`

Folders: POST /api/v2/solutions/folders/\[id]/\[language\_code] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesPostLanguageCode.run({ pathParams: { id: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   name?: string | null,
>   description?: string | null,
>   parent_folder_id?: number | null,
>   hierarchy?: JsonValue[] | null,
>   articles_count?: number | null,
>   sub_folders_count?: number | null,
>   visibility?: number | null,
>   company_ids?: number[] | null,
>   contact_segment_ids?: number[] | null,
>   company_segment_ids?: number[] | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesPut.run

`routes.solutionFolderAttributesPut.run`

Folders: PUT /api/v2/solutions/folders/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   name?: string | null,
>   description?: string | null,
>   parent_folder_id?: number | null,
>   hierarchy?: JsonValue[] | null,
>   articles_count?: number | null,
>   sub_folders_count?: number | null,
>   visibility?: number | null,
>   company_ids?: number[] | null,
>   contact_segment_ids?: number[] | null,
>   company_segment_ids?: number[] | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### solutionFolderAttributesPutLanguageCode.run

`routes.solutionFolderAttributesPutLanguageCode.run`

Folders: PUT /api/v2/solutions/folders/\[id]/\[language\_code] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.solutionFolderAttributesPutLanguageCode.run({ pathParams: { id: '123', languageCode: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   languageCode: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   name?: string | null,
>   description?: string | null,
>   parent_folder_id?: number | null,
>   hierarchy?: JsonValue[] | null,
>   articles_count?: number | null,
>   sub_folders_count?: number | null,
>   visibility?: number | null,
>   company_ids?: number[] | null,
>   contact_segment_ids?: number[] | null,
>   company_segment_ids?: number[] | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### ticketAssociationGetAssociatedTickets.run

`routes.ticketAssociationGetAssociatedTickets.run`

Ticket Association API: GET /api/v2/tickets/\[id]/associated\_tickets (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.ticketAssociationGetAssociatedTickets.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### ticketAssociationGetPrimeAssociation.run

`routes.ticketAssociationGetPrimeAssociation.run`

Ticket Association API: GET /api/v2/tickets/\[id]/prime\_association (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.ticketAssociationGetPrimeAssociation.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### ticketMergePutMerge.run

`routes.ticketMergePutMerge.run`

Ticket Merge API: PUT /api/v2/tickets/merge (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.ticketMergePutMerge.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   primary_id?: number | null,
>   ticket_ids?: number[] | null,
>   note_in_primary?: Record<string, JsonValue> | null,
>   note_in_secondary?: Record<string, JsonValue> | null,
>   convert_recepients_to_cc?: boolean | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### ticketSummaryDeleteSummary.run

`routes.ticketSummaryDeleteSummary.run`

Ticket Summary: DELETE /api/v2/tickets/\[id]/summary (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.ticketSummaryDeleteSummary.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### ticketSummaryGetSummary.run

`routes.ticketSummaryGetSummary.run`

Ticket Summary: GET /api/v2/tickets/\[id]/summary (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.ticketSummaryGetSummary.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### ticketSummaryPutSummary.run

`routes.ticketSummaryPutSummary.run`

Ticket Summary: PUT /api/v2/tickets/\[id]/summary (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.ticketSummaryPutSummary.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   body?: string | null,
>   attachments?: JsonValue[] | null,
>   user_id?: number | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### ticketUserAccessesDeleteAccesses.run

`routes.ticketUserAccessesDeleteAccesses.run`

Ticket User Access: DELETE /api/v2/tickets/\[id]/accesses (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.ticketUserAccessesDeleteAccesses.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### ticketUserAccessesGetAccesses.run

`routes.ticketUserAccessesGetAccesses.run`

Ticket User Access: GET /api/v2/tickets/\[id]/accesses (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.ticketUserAccessesGetAccesses.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### ticketUserAccessesPatchAccesses.run

`routes.ticketUserAccessesPatchAccesses.run`

Ticket User Access: PATCH /api/v2/tickets/\[id]/accesses (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.ticketUserAccessesPatchAccesses.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   user_ids?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### ticketUserAccessesPostAccesses.run

`routes.ticketUserAccessesPostAccesses.run`

Ticket User Access: POST /api/v2/tickets/\[id]/accesses (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.ticketUserAccessesPostAccesses.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   user_ids?: number[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### toggleTimeEntryPutToggleTimer.run

`routes.toggleTimeEntryPutToggleTimer.run`

Start/Stop Timer: PUT /api/v2/time\_entries/\[time\_entry\_id]/toggle\_timer (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.toggleTimeEntryPutToggleTimer.run({ pathParams: { timeEntryId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   timeEntryId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### topicAttributesDelete.run

`routes.topicAttributesDelete.run`

Topics: DELETE /api/v2/discussions/topics/\[id] (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.topicAttributesDelete.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### topicAttributesDeleteFollow\.run

`routes.topicAttributesDeleteFollow.run`

Topics: DELETE /api/v2/discussions/topics/\[topic\_id]/follow (Freshdesk API v2).

**Risk:** `destructive`

```ts theme={null}
await corsair.freshdesk.api.routes.topicAttributesDeleteFollow.run({ pathParams: { topicId: '123' }, query: { user_id: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   topicId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   user_id: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### topicAttributesGet.run

`routes.topicAttributesGet.run`

Topics: GET /api/v2/discussions/topics/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.topicAttributesGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### topicAttributesGetComments.run

`routes.topicAttributesGetComments.run`

Topics: GET /api/v2/discussions/topics/\[id]/comments (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.topicAttributesGetComments.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### topicAttributesGetFollow\.run

`routes.topicAttributesGetFollow.run`

Topics: GET /api/v2/discussions/topics/\[id]/follow (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.topicAttributesGetFollow.run({ pathParams: { id: '123' }, query: { user_id: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   user_id: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### topicAttributesGetFollowedBy.run

`routes.topicAttributesGetFollowedBy.run`

Topics: GET /api/v2/discussions/topics/followed\_by (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.topicAttributesGetFollowedBy.run({ query: { user_id: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   user_id: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### topicAttributesGetParticipatedBy.run

`routes.topicAttributesGetParticipatedBy.run`

Topics: GET /api/v2/discussions/topics/participated\_by (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.topicAttributesGetParticipatedBy.run({ query: { user_id: 'sample' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `object` | Yes | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   user_id: string | number | boolean | (string | number | boolean)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### topicAttributesPostFollow\.run

`routes.topicAttributesPostFollow.run`

Topics: POST /api/v2/discussions/topics/\[id]/follow (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.topicAttributesPostFollow.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   forum_id?: number | null,
>   hits?: number | null,
>   id?: number | null,
>   locked?: boolean | null,
>   merged_topic_id?: number | null,
>   message?: string | null,
>   posts_count?: number | null,
>   replied_at?: string | null,
>   replied_by?: string | null,
>   stamp_type?: number | null,
>   sticky?: boolean | null,
>   title?: string | null,
>   user_id?: number | null,
>   user_votes?: number | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### topicAttributesPostTopics.run

`routes.topicAttributesPostTopics.run`

Topics: POST /api/v2/discussions/forums/\[forum\_id]/topics (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.topicAttributesPostTopics.run({ pathParams: { forumId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   forumId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   forum_id?: number | null,
>   hits?: number | null,
>   id?: number | null,
>   locked?: boolean | null,
>   merged_topic_id?: number | null,
>   message?: string | null,
>   posts_count?: number | null,
>   replied_at?: string | null,
>   replied_by?: string | null,
>   stamp_type?: number | null,
>   sticky?: boolean | null,
>   title?: string | null,
>   user_id?: number | null,
>   user_votes?: number | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### topicAttributesPut.run

`routes.topicAttributesPut.run`

Topics: PUT /api/v2/discussions/topics/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.topicAttributesPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   forum_id?: number | null,
>   hits?: number | null,
>   id?: number | null,
>   locked?: boolean | null,
>   merged_topic_id?: number | null,
>   message?: string | null,
>   posts_count?: number | null,
>   replied_at?: string | null,
>   replied_by?: string | null,
>   stamp_type?: number | null,
>   sticky?: boolean | null,
>   title?: string | null,
>   user_id?: number | null,
>   user_votes?: number | null,
>   created_at?: string | null,
>   updated_at?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateACustomObjectRecordPutRecordId.run

`routes.updateACustomObjectRecordPutRecordId.run`

Update A Record: PUT /api/v2/custom\_objects/schemas/\[schema\_id]/records/\[record\_id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateACustomObjectRecordPutRecordId.run({ pathParams: { schemaId: '123', recordId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   schemaId: string,
>   recordId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   display_id?: string | null,
>   data?: Record<string, JsonValue> | null,
>   version?: number | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateAdminGroupPut.run

`routes.updateAdminGroupPut.run`

Update a Group: PUT /api/v2/admin/groups/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateAdminGroupPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   description?: string | null,
>   type?: string | null,
>   escalate_to?: number | null,
>   unassigned_for?: string | null,
>   agent_ids?: JsonValue[] | null,
>   business_calendar_id?: number | null,
>   allow_agents_to_change_availability?: boolean | null,
>   automatic_agent_assignment?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateAgentAvailabilityPutAvailability.run

`routes.updateAgentAvailabilityPutAvailability.run`

Update Agent load settings: PATCH /api/v2/agents/\[id]/availability (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateAgentAvailabilityPutAvailability.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   channel_availability?: JsonValue[] | null,
>   availability_control?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateAgentPut.run

`routes.updateAgentPut.run`

Update an Agent: PUT /api/v2/agents/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateAgentPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   occasional?: boolean | null,
>   signature?: string | null,
>   ticket_scope?: number | null,
>   skill_ids?: number[] | null,
>   group_ids?: number[] | null,
>   role_ids?: number[] | null,
>   email?: string | null,
>   language?: string | null,
>   time_zone?: string | null,
>   focus_mode?: boolean | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateAnAutomationRulePut.run

`routes.updateAnAutomationRulePut.run`

Update an Automation Rule: PUT /api/v2/automations/\[automation\_type\_id]/rules/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateAnAutomationRulePut.run({ pathParams: { automationTypeId: '123', id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   automationTypeId: string,
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   description?: string | null,
>   position?: number | null,
>   active?: boolean | null,
>   performer?: JsonValue,
>   events?: JsonValue[] | null,
>   conditions?: JsonValue[] | null,
>   operator?: string | null,
>   actions?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateAThreadPut.run

`routes.updateAThreadPut.run`

Update a thread: PUT /api/v2/collaboration/threads/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateAThreadPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title?: string | null,
>   description?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateAutomaticBccEmailsPutBcc.run

`routes.updateAutomaticBccEmailsPutBcc.run`

Update Automatic Bcc emails: PUT /api/v2/notifications/email/bcc (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateAutomaticBccEmailsPutBcc.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   emails?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateCannedResponseFolderPut.run

`routes.updateCannedResponseFolderPut.run`

Update Folder: PUT /api/v2/canned\_response\_folders/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateCannedResponseFolderPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateCannedResponsePut.run

`routes.updateCannedResponsePut.run`

Update a canned response: PUT /api/v2/canned\_responses/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateCannedResponsePut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title?: string | null,
>   content_html?: string | null,
>   folder_id?: number | null,
>   visibility?: number | null,
>   group_ids?: number[] | null,
>   attachments?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateCompanyFieldPut.run

`routes.updateCompanyFieldPut.run`

Update a company field: PUT /api/v2/company\_fields/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateCompanyFieldPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   label?: string | null,
>   position?: number | null,
>   required_for_agents?: boolean | null,
>   agents_can_edit?: boolean | null,
>   displayed_for_agents?: boolean | null,
>   quick_add_for_agent?: boolean | null,
>   unique?: boolean | null,
>   choices?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateCompanyPut.run

`routes.updateCompanyPut.run`

Update a Company: PUT /api/v2/companies/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateCompanyPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   custom_fields?: Record<string, JsonValue> | null,
>   description?: string | null,
>   domains?: JsonValue[] | null,
>   name?: string | null,
>   note?: string | null,
>   health_score?: string | null,
>   account_tier?: string | null,
>   renewal_date?: string | null,
>   industry?: string | null,
>   lookup_parameter?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateContactFieldPut.run

`routes.updateContactFieldPut.run`

Update a contact field: PUT /api/v2/contact\_fields/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateContactFieldPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   label?: string | null,
>   label_for_customers?: string | null,
>   editable_in_signup?: boolean | null,
>   position?: number | null,
>   required_for_agents?: boolean | null,
>   agents_can_edit?: boolean | null,
>   displayed_for_agents?: boolean | null,
>   quick_add_for_agent?: boolean | null,
>   unique?: boolean | null,
>   customers_can_edit?: boolean | null,
>   required_for_customers?: boolean | null,
>   displayed_for_customers?: boolean | null,
>   choices?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateContactPut.run

`routes.updateContactPut.run`

Update a Contact: PUT /api/v2/contacts/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateContactPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   email?: string | null,
>   phone?: string | null,
>   mobile?: string | null,
>   twitter_id?: string | null,
>   social_handler?: JsonValue[] | null,
>   unique_external_id?: string | null,
>   other_emails?: string[] | null,
>   company_id?: number | null,
>   view_all_tickets?: boolean | null,
>   other_companies?: JsonValue[] | null,
>   address?: string | null,
>   avatar?: Record<string, JsonValue> | null,
>   custom_fields?: Record<string, JsonValue> | null,
>   description?: string | null,
>   job_title?: string | null,
>   language?: string | null,
>   tags?: string[] | null,
>   time_zone?: string | null,
>   lookup_parameter?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateConversationPut.run

`routes.updateConversationPut.run`

Update a conversation: PUT /api/v2/conversations/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateConversationPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   attachments?: JsonValue[] | null,
>   body?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateEmailMailboxPut.run

`routes.updateEmailMailboxPut.run`

Update an Email Mailbox: PUT /api/v2/email/mailboxes/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateEmailMailboxPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   support_email?: string | null,
>   group_id?: number | null,
>   product_id?: number | null,
>   default_reply_email?: boolean | null,
>   mailbox_type?: string | null,
>   custom_mailbox?: Record<string, JsonValue> | null,
>   access_type?: string | null,
>   incoming?: Record<string, JsonValue> | null,
>   mail_server?: string | null,
>   port?: number | null,
>   use_ssl?: boolean | null,
>   delete_from_server?: boolean | null,
>   authentication?: string | null,
>   username?: string | null,
>   password?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateGroupPut.run

`routes.updateGroupPut.run`

Update a Group: PUT /api/v2/groups/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateGroupPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   agent_ids?: JsonValue[] | null,
>   auto_ticket_assign?: number | null,
>   description?: string | null,
>   escalate_to?: number | null,
>   name?: string | null,
>   unassigned_for?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateMailboxSettingsPutSettings.run

`routes.updateMailboxSettingsPutSettings.run`

Update Mailbox Settings: PUT /api/v2/email/settings (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateMailboxSettingsPutSettings.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   personalized_email_replies?: boolean | null,
>   create_requester_using_reply_to?: boolean | null,
>   allow_agent_to_initiate_conversation?: boolean | null,
>   original_sender_as_requester_for_forward?: boolean | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateMessageForThreadPut.run

`routes.updateMessageForThreadPut.run`

Update message for thread: PUT /api/v2/collaboration/messages/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateMessageForThreadPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title?: string | null,
>   description?: string | null,
>   body?: string | null,
>   participants?: Record<string, JsonValue> | null,
>   additional_info?: Record<string, JsonValue> | null,
>   attachment_ids?: string[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateSectionPutSectionId.run

`routes.updateSectionPutSectionId.run`

Update a section: PUT /api/v2/admin/ticket\_fields/\[id]/sections/\[section\_id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateSectionPutSectionId.run({ pathParams: { id: '123', sectionId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string,
>   sectionId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   label?: string | null,
>   choice_ids?: number[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateSkillPut.run

`routes.updateSkillPut.run`

Update a Skill: PATCH /api/v2/admin/skills/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateSkillPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   rank?: string | null,
>   agents?: JsonValue[] | null,
>   match_type?: string | null,
>   conditions?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateSlaPolicyPut.run

`routes.updateSlaPolicyPut.run`

Update an SLA Policy: PUT /api/v2/sla\_policies/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateSlaPolicyPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   applicable_to?: Record<string, JsonValue> | null,
>   name?: string | null,
>   description?: string | null,
>   active?: boolean | null,
>   is_default?: boolean | null,
>   position?: number | null,
>   sla_target?: Record<string, JsonValue> | null,
>   escalation?: Record<string, JsonValue> | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateTicketFieldPut.run

`routes.updateTicketFieldPut.run`

Update a Ticket Field: PUT /api/v2/admin/ticket\_fields/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateTicketFieldPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customers_can_edit?: boolean | null,
>   label_for_customers?: string | null,
>   displayed_to_customers?: boolean | null,
>   label?: string | null,
>   type?: string | null,
>   position?: number | null,
>   required_for_closure?: boolean | null,
>   required_for_agents?: boolean | null,
>   required_for_customers?: boolean | null,
>   choices?: JsonValue[] | null,
>   dependent_fields?: JsonValue[] | null,
>   section_mappings?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateTicketFormFieldPutFieldId.run

`routes.updateTicketFormFieldPutFieldId.run`

Update A Ticket Form's Field: PUT /api/v2/ticket-forms/\[form-id]/fields/\[field-id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateTicketFormFieldPutFieldId.run({ pathParams: { formId: '123', fieldId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   formId: string,
>   fieldId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   label_for_customers?: string | null,
>   customers_can_edit?: boolean | null,
>   required_for_customers?: boolean | null,
>   hint_for_customers?: string | null,
>   placeholder_for_customers?: string | null,
>   position?: number | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateTicketFormPut.run

`routes.updateTicketFormPut.run`

Update a Ticket Form: PUT /api/v2/ticket-forms/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateTicketFormPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title?: string | null,
>   description?: string | null,
>   fields?: JsonValue[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateTicketPut.run

`routes.updateTicketPut.run`

Update a Ticket: PUT /api/v2/tickets/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateTicketPut.run({ pathParams: { id: '123' }, body: { status: 4 } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   requester_id?: number | null,
>   email?: string | null,
>   facebook_id?: string | null,
>   phone?: string | null,
>   twitter_id?: string | null,
>   unique_external_id?: string | null,
>   subject?: string | null,
>   type?: string | null,
>   status?: number | null,
>   priority?: number | null,
>   description?: string | null,
>   responder_id?: number | null,
>   attachments?: JsonValue[] | null,
>   custom_fields?: Record<string, JsonValue> | null,
>   due_by?: string | null,
>   email_config_id?: number | null,
>   fr_due_by?: string | null,
>   group_id?: number | null,
>   parent_id?: number | null,
>   product_id?: number | null,
>   source?: number | null,
>   tags?: string[] | null,
>   company_id?: number | null,
>   internal_agent_id?: number | null,
>   internal_group_id?: number | null,
>   lookup_parameter?: string | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### updateTimeEntryPut.run

`routes.updateTimeEntryPut.run`

Update a Time Entry: PUT /api/v2/time\_entries/\[id] (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.updateTimeEntryPut.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   agent_id?: number | null,
>   billable?: boolean | null,
>   executed_at?: string | null,
>   note?: string | null,
>   start_time?: string | null,
>   time_spent?: string | null,
>   timer_running?: boolean | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewAccountGetAccount.run

`routes.viewAccountGetAccount.run`

View Account: GET /api/v2/account (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewAccountGetAccount.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewAdminGroupGet.run

`routes.viewAdminGroupGet.run`

View a Group: GET /api/v2/admin/groups/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewAdminGroupGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewAgentAvailabilityGetAvailability.run

`routes.viewAgentAvailabilityGetAvailability.run`

View Agent Availability: GET /api/v2/agents/\[id]/availability (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewAgentAvailabilityGetAvailability.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewAgentGet.run

`routes.viewAgentGet.run`

View an Agent: GET /api/v2/agents/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewAgentGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewAllSatisfactionRatingsGetSatisfactionRatings.run

`routes.viewAllSatisfactionRatingsGetSatisfactionRatings.run`

View all Satisfaction Ratings: GET /api/v2/surveys/satisfaction\_ratings (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewAllSatisfactionRatingsGetSatisfactionRatings.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewAnAutomationRuleGet.run

`routes.viewAnAutomationRuleGet.run`

View an Automation Rule: GET /api/v2/automations/\[automation\_type\_id]/rules/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewAnAutomationRuleGet.run({ pathParams: { automationTypeId: '123', id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   automationTypeId: string,
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewATicketGet.run

`routes.viewATicketGet.run`

View a Ticket: GET /api/v2/tickets/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewATicketGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewAutomaticBccEmailsGetBcc.run

`routes.viewAutomaticBccEmailsGetBcc.run`

View Automatic Bcc emails: GET /api/v2/notifications/email/bcc (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewAutomaticBccEmailsGetBcc.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewBusinessHourGet.run

`routes.viewBusinessHourGet.run`

View a Business Hour: GET /api/v2/business\_hours/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewBusinessHourGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewCannedResponseFoldersGet.run

`routes.viewCannedResponseFoldersGet.run`

List All Canned Responses in a Folder: GET /api/v2/canned\_response\_folders/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewCannedResponseFoldersGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewCannedResponseGet.run

`routes.viewCannedResponseGet.run`

View a Canned Response: GET /api/v2/canned\_responses/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewCannedResponseGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewCompanyFieldGet.run

`routes.viewCompanyFieldGet.run`

View a company field: GET /api/v2/company\_fields/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewCompanyFieldGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewCompanyGet.run

`routes.viewCompanyGet.run`

View a Company: GET /api/v2/companies/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewCompanyGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewContactFieldGet.run

`routes.viewContactFieldGet.run`

View a contact field: GET /api/v2/contact\_fields/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewContactFieldGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewContactGet.run

`routes.viewContactGet.run`

View a Contact: GET /api/v2/contacts/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewContactGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewEmailConfigGet.run

`routes.viewEmailConfigGet.run`

View an Email Config: GET /api/v2/email\_configs/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewEmailConfigGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewEmailMailboxGet.run

`routes.viewEmailMailboxGet.run`

View an Email Mailbox: GET /api/v2/email/mailboxes/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewEmailMailboxGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewGroupGet.run

`routes.viewGroupGet.run`

View a Group: GET /api/v2/groups/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewGroupGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewJobGet.run

`routes.viewJobGet.run`

View a Job: GET /api/v2/jobs/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewJobGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewMailboxSettingsGetSettings.run

`routes.viewMailboxSettingsGetSettings.run`

View Mailbox Settings: GET /api/v2/email/settings (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewMailboxSettingsGetSettings.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewProductGet.run

`routes.viewProductGet.run`

View a Product: GET /api/v2/products/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewProductGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewRoleGet.run

`routes.viewRoleGet.run`

View a Role: GET /api/v2/roles/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewRoleGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewSkillGet.run

`routes.viewSkillGet.run`

View a Skill: GET /api/v2/admin/skills/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewSkillGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewSurveyResponsesGetResponses.run

`routes.viewSurveyResponsesGetResponses.run`

View all Survey Responses: GET /api/v2/customer-satisfaction/surveys/\[survey\_id]/responses (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewSurveyResponsesGetResponses.run({ pathParams: { surveyId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   surveyId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewTicketFieldGet.run

`routes.viewTicketFieldGet.run`

View a Ticket Field: GET /api/v2/admin/ticket\_fields/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewTicketFieldGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewTicketFormFieldGetFieldId.run

`routes.viewTicketFormFieldGetFieldId.run`

View A Ticket Form's Field: GET /api/v2/ticket-forms/\[form-id]/fields/\[field-id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewTicketFormFieldGetFieldId.run({ pathParams: { formId: '123', fieldId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   formId: string,
>   fieldId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewTicketFormGet.run

`routes.viewTicketFormGet.run`

View a Ticket Form: GET /api/v2/ticket-forms/\[id] (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewTicketFormGet.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### viewTicketSatisfactionRatingsGetSatisfactionRatings.run

`routes.viewTicketSatisfactionRatingsGetSatisfactionRatings.run`

List All Satisfaction Ratings of a Ticket: GET /api/v2/tickets/\[ticket\_id]/satisfaction\_ratings (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.viewTicketSatisfactionRatingsGetSatisfactionRatings.run({ pathParams: { ticketId: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   ticketId: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### watcherGetWatchers.run

`routes.watcherGetWatchers.run`

Watcher: GET /api/v2/tickets/\[id]/watchers (Freshdesk API v2).

**Risk:** `read`

```ts theme={null}
await corsair.freshdesk.api.routes.watcherGetWatchers.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### watcherPostWatch.run

`routes.watcherPostWatch.run`

Watcher: POST /api/v2/tickets/\[id]/watch (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.watcherPostWatch.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: number[] | null,
>   user_id?: number | null,
>   watcher_ids?: number[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### watcherPutBulkUnwatch.run

`routes.watcherPutBulkUnwatch.run`

Watcher: PUT /api/v2/tickets/bulk\_unwatch (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.watcherPutBulkUnwatch.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: number[] | null,
>   user_id?: number | null,
>   watcher_ids?: number[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### watcherPutBulkWatch.run

`routes.watcherPutBulkWatch.run`

Watcher: PUT /api/v2/tickets/bulk\_watch (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.watcherPutBulkWatch.run({  });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | No | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: number[] | null,
>   user_id?: number | null,
>   watcher_ids?: number[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***

### watcherPutUnwatch.run

`routes.watcherPutUnwatch.run`

Watcher: PUT /api/v2/tickets/\[id]/unwatch (Freshdesk API v2).

**Risk:** `write`

```ts theme={null}
await corsair.freshdesk.api.routes.watcherPutUnwatch.run({ pathParams: { id: '123' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `pathParams` | `object` | Yes | — |
| `query` | `Record<string, string \| number \| boolean \| (string \| number \| boolean)[]>` | No | — |
| `body` | `object` | No | — |
| `attachments` | `object[]` | No | — |

> [accordion] pathParams full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: number[] | null,
>   user_id?: number | null,
>   watcher_ids?: number[] | null
> }
> ```

> [accordion] attachments full type
>
> ```ts theme={null}
> {
>   filename: string,
>   contentType: string,
>   base64: string
> }[]
> ```

**Output:** `JsonValue \| undefined`

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.