# SupportNotesApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createSupportTicketNote**](#createsupportticketnote) | **POST** /supportTickets/{supportTicketId}/notes | Add an internal note to a support ticket|
|[**deleteSupportTicketNote**](#deletesupportticketnote) | **DELETE** /supportTickets/{supportTicketId}/notes/{noteId} | Delete a support ticket\'s internal note|
|[**getSupportTicketNotes**](#getsupportticketnotes) | **GET** /supportTickets/{supportTicketId}/notes | List a support ticket\'s internal notes|

# **createSupportTicketNote**
> CreateSupportTicket200Response createSupportTicketNote(supportTicketNoteCreateInputs)

Adds an admin-only internal note to the specified support ticket, recording the authoring admin; requires \"update\" permission on support.

### Example

```typescript
import {
    SupportNotesApi,
    Configuration,
    SupportTicketNoteCreateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new SupportNotesApi(configuration);

let supportTicketId: string; //The supportTicket identifier (default to undefined)
let supportTicketNoteCreateInputs: SupportTicketNoteCreateInputs; //

const { status, data } = await apiInstance.createSupportTicketNote(
    supportTicketId,
    supportTicketNoteCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **supportTicketNoteCreateInputs** | **SupportTicketNoteCreateInputs**|  | |
| **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|


### Return type

**CreateSupportTicket200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteSupportTicketNote**
> CreateAccountInvitations200Response deleteSupportTicketNote()

Permanently removes an internal note from the specified support ticket; requires \"update\" permission on support.

### Example

```typescript
import {
    SupportNotesApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new SupportNotesApi(configuration);

let supportTicketId: string; //The supportTicket identifier (default to undefined)
let noteId: string; //The note identifier (default to undefined)

const { status, data } = await apiInstance.deleteSupportTicketNote(
    supportTicketId,
    noteId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
| **noteId** | [**string**] | The note identifier | defaults to undefined|


### Return type

**CreateAccountInvitations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getSupportTicketNotes**
> GetSupportTicketNotes200Response getSupportTicketNotes()

Returns a paginated list of internal notes added to the given support ticket by admin staff, with optional search and ordering, requiring \"read\" permission on support.

### Example

```typescript
import {
    SupportNotesApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new SupportNotesApi(configuration);

let supportTicketId: string; //The supportTicket identifier (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getSupportTicketNotes(
    supportTicketId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetSupportTicketNotes200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)