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

# sysaid

> SysAid ITSM

**Server path:** `/sysaid` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                          | Description                         |
| ----------------------------------------------------------------------------- | ----------------------------------- |
| [`sysaid_add_agent_to_groups`](#sysaid_add_agent_to_groups)                   | Add groups to agent's profile.      |
| [`sysaid_add_end_user_to_groups`](#sysaid_add_end_user_to_groups)             | Add groups to user's profile.       |
| [`sysaid_add_service_record_note`](#sysaid_add_service_record_note)           | Adds a note to a service record     |
| [`sysaid_create_agent`](#sysaid_create_agent)                                 | Create a new agent                  |
| [`sysaid_create_end_user`](#sysaid_create_end_user)                           | Create a new end user               |
| [`sysaid_create_group`](#sysaid_create_group)                                 | Create a new group                  |
| [`sysaid_create_webhook`](#sysaid_create_webhook)                             | Create a new webhook subscription   |
| [`sysaid_delete_agent`](#sysaid_delete_agent)                                 | Delete agent                        |
| [`sysaid_delete_end_user`](#sysaid_delete_end_user)                           | Delete end user                     |
| [`sysaid_get_agent`](#sysaid_get_agent)                                       | Get agent by ID                     |
| [`sysaid_get_end_user`](#sysaid_get_end_user)                                 | Get end user by ID                  |
| [`sysaid_get_group`](#sysaid_get_group)                                       | Get group by ID                     |
| [`sysaid_get_group_members`](#sysaid_get_group_members)                       | Get group members                   |
| [`sysaid_get_service_record_by_id`](#sysaid_get_service_record_by_id)         | Get a service record by id          |
| [`sysaid_get_webhook_subscriber_by_id`](#sysaid_get_webhook_subscriber_by_id) | Get webhook subscriber by ID        |
| [`sysaid_remove_agent_from_groups`](#sysaid_remove_agent_from_groups)         | Remove groups from agent's profile. |
| [`sysaid_remove_end_user_from_groups`](#sysaid_remove_end_user_from_groups)   | Remove groups from user's profile.  |
| [`sysaid_update_agent`](#sysaid_update_agent)                                 | Update agent                        |
| [`sysaid_update_end_user`](#sysaid_update_end_user)                           | Update end user                     |
| [`sysaid_update_service_record`](#sysaid_update_service_record)               | Update a service record properties  |

***

## sysaid\_add\_agent\_to\_groups

Add groups to agent's profile.

**Parameters:**

| Parameter  | Type       | Required | Default | Description                         |
| ---------- | ---------- | -------- | ------- | ----------------------------------- |
| `id`       | integer    | Yes      | —       | The unique identifier of the agent. |
| `groupIds` | integer\[] | Yes      | —       | A list of group IDs                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the agent."
      },
      "groupIds": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "A list of group IDs"
      }
    },
    "required": [
      "PCID",
      "id",
      "groupIds"
    ]
  }
  ```
</Expandable>

***

## sysaid\_add\_end\_user\_to\_groups

Add groups to user's profile.

**Parameters:**

| Parameter  | Type       | Required | Default | Description                            |
| ---------- | ---------- | -------- | ------- | -------------------------------------- |
| `id`       | integer    | Yes      | —       | The unique identifier of the end user. |
| `groupIds` | integer\[] | Yes      | —       | A list of group IDs                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the end user."
      },
      "groupIds": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "A list of group IDs"
      }
    },
    "required": [
      "PCID",
      "id",
      "groupIds"
    ]
  }
  ```
</Expandable>

***

## sysaid\_add\_service\_record\_note

Adds a note to a service record

**Parameters:**

| Parameter            | Type    | Required | Default | Description                                                                                |
| -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------ |
| `recordId`           | integer | Yes      | —       | The unique ID of the service record                                                        |
| `body`               | string  | Yes      | —       | Text of the added note                                                                     |
| `sendNotification`   | boolean | No       | —       | Specifies whether to send a notification about added note to the relevant persons          |
| `shareWithRequester` | boolean | No       | —       | Specifies whether the added note should be shared with the service record's requester user |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "recordId": {
        "type": "integer",
        "description": "The unique ID of the service record"
      },
      "body": {
        "type": "string",
        "description": "Text of the added note"
      },
      "sendNotification": {
        "type": "boolean",
        "description": "Specifies whether to send a notification about added note to the relevant persons"
      },
      "shareWithRequester": {
        "type": "boolean",
        "description": "Specifies whether the added note should be shared with the service record's requester user"
      }
    },
    "required": [
      "PCID",
      "recordId",
      "body"
    ]
  }
  ```
</Expandable>

***

## sysaid\_create\_agent

Create a new agent

**Parameters:**

| Parameter                | Type    | Required | Default | Description                                           |                                                    |
| ------------------------ | ------- | -------- | ------- | ----------------------------------------------------- | -------------------------------------------------- |
| `companyId`              | number  | null     | No      | —                                                     | Unique ID of the company the user works for        |
| `departmentId`           | number  | null     | No      | —                                                     | Unique ID of the department the user belongs to    |
| `displayName`            | string  | No       | —       | The user's display name                               |                                                    |
| `enablePortalLogin`      | boolean | No       | —       | Enable login to the End User Portal                   |                                                    |
| `firstName`              | string  | Yes      | —       | The user's first name.                                |                                                    |
| `isDisabled`             | boolean | No       | —       | Indicates if the user is disabled                     |                                                    |
| `language`               | string  | No       | —       | The language used by the user (default is "en")       |                                                    |
| `lastName`               | string  | No       | —       | The user's last name.                                 |                                                    |
| `locationId`             | number  | null     | No      | —                                                     | Unique ID of the location associated with the user |
| `managerId`              | integer | No       | —       | Manager Id                                            |                                                    |
| `mobile`                 | string  | No       | —       | User's mobile number                                  |                                                    |
| `receiveSRNotifications` | boolean | No       | —       | Enable or disable automatic SR email notifications    |                                                    |
| `supervisorLevel`        | string  | No       | —       | Enable the user to have access to other's ssp tickets |                                                    |
| `timezone`               | string  | No       | —       | The time zone of the user                             |                                                    |
| `userEmail`              | string  | No       | —       | The user's email address.                             |                                                    |
| `userName`               | string  | Yes      | —       | The name of the user as provided by the SysAdmin      |                                                    |
| `workPhone`              | string  | No       | —       | User's work phone number/extension                    |                                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "companyId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the company the user works for"
      },
      "departmentId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the department the user belongs to"
      },
      "displayName": {
        "type": "string",
        "description": "The user's display name"
      },
      "enablePortalLogin": {
        "type": "boolean",
        "description": "Enable login to the End User Portal"
      },
      "firstName": {
        "type": "string",
        "description": "The user's first name."
      },
      "isDisabled": {
        "type": "boolean",
        "description": "Indicates if the user is disabled"
      },
      "language": {
        "type": "string",
        "description": "The language used by the user (default is \"en\")"
      },
      "lastName": {
        "type": "string",
        "description": "The user's last name."
      },
      "locationId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the location associated with the user"
      },
      "managerId": {
        "type": "integer",
        "description": "Manager Id"
      },
      "mobile": {
        "type": "string",
        "description": "User's mobile number"
      },
      "receiveSRNotifications": {
        "type": "boolean",
        "description": "Enable or disable automatic SR email notifications"
      },
      "supervisorLevel": {
        "type": "string",
        "description": "Enable the user to have access to other's ssp tickets",
        "enum": [
          "NONE",
          "DEPARTMENT",
          "COMPANY"
        ]
      },
      "timezone": {
        "type": "string",
        "description": "The time zone of the user"
      },
      "userEmail": {
        "type": "string",
        "description": "The user's email address."
      },
      "userName": {
        "type": "string",
        "description": "The name of the user as provided by the SysAdmin"
      },
      "workPhone": {
        "type": "string",
        "description": "User's work phone number/extension"
      }
    },
    "required": [
      "PCID",
      "firstName",
      "userName"
    ]
  }
  ```
</Expandable>

***

## sysaid\_create\_end\_user

Create a new end user

**Parameters:**

| Parameter                | Type    | Required | Default | Description                                           |                                                    |
| ------------------------ | ------- | -------- | ------- | ----------------------------------------------------- | -------------------------------------------------- |
| `companyId`              | number  | null     | No      | —                                                     | Unique ID of the company the user works for        |
| `departmentId`           | number  | null     | No      | —                                                     | Unique ID of the department the user belongs to    |
| `displayName`            | string  | No       | —       | The user's display name                               |                                                    |
| `enablePortalLogin`      | boolean | No       | —       | Enable login to the End User Portal                   |                                                    |
| `firstName`              | string  | Yes      | —       | The user's first name.                                |                                                    |
| `isDisabled`             | boolean | No       | —       | Indicates if the user is disabled                     |                                                    |
| `language`               | string  | No       | —       | The language used by the user (default is "en")       |                                                    |
| `lastName`               | string  | No       | —       | The user's last name.                                 |                                                    |
| `locationId`             | number  | null     | No      | —                                                     | Unique ID of the location associated with the user |
| `managerId`              | integer | No       | —       | Manager Id                                            |                                                    |
| `mobile`                 | string  | No       | —       | User's mobile number                                  |                                                    |
| `receiveSRNotifications` | boolean | No       | —       | Enable or disable automatic SR email notifications    |                                                    |
| `supervisorLevel`        | string  | No       | —       | Enable the user to have access to other's ssp tickets |                                                    |
| `timezone`               | string  | No       | —       | The time zone of the user                             |                                                    |
| `userEmail`              | string  | No       | —       | The user's email address.                             |                                                    |
| `userName`               | string  | Yes      | —       | The name of the user as provided by the SysAdmin      |                                                    |
| `workPhone`              | string  | No       | —       | User's work phone number/extension                    |                                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "companyId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the company the user works for"
      },
      "departmentId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the department the user belongs to"
      },
      "displayName": {
        "type": "string",
        "description": "The user's display name"
      },
      "enablePortalLogin": {
        "type": "boolean",
        "description": "Enable login to the End User Portal"
      },
      "firstName": {
        "type": "string",
        "description": "The user's first name."
      },
      "isDisabled": {
        "type": "boolean",
        "description": "Indicates if the user is disabled"
      },
      "language": {
        "type": "string",
        "description": "The language used by the user (default is \"en\")"
      },
      "lastName": {
        "type": "string",
        "description": "The user's last name."
      },
      "locationId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the location associated with the user"
      },
      "managerId": {
        "type": "integer",
        "description": "Manager Id"
      },
      "mobile": {
        "type": "string",
        "description": "User's mobile number"
      },
      "receiveSRNotifications": {
        "type": "boolean",
        "description": "Enable or disable automatic SR email notifications"
      },
      "supervisorLevel": {
        "type": "string",
        "description": "Enable the user to have access to other's ssp tickets",
        "enum": [
          "NONE",
          "DEPARTMENT",
          "COMPANY"
        ]
      },
      "timezone": {
        "type": "string",
        "description": "The time zone of the user"
      },
      "userEmail": {
        "type": "string",
        "description": "The user's email address."
      },
      "userName": {
        "type": "string",
        "description": "The name of the user as provided by the SysAdmin"
      },
      "workPhone": {
        "type": "string",
        "description": "User's work phone number/extension"
      }
    },
    "required": [
      "PCID",
      "firstName",
      "userName"
    ]
  }
  ```
</Expandable>

***

## sysaid\_create\_group

Create a new group

**Parameters:**

| Parameter                                 | Type    | Required | Default | Description                                                                                                                   |                                                                  |
| ----------------------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `canBeAssignedToServiceRecord`            | boolean | No       | —       | Indicates if the group can be assigned to a service record. Not applicable if `type` is set to `END_USERS`.                   |                                                                  |
| `companyId`                               | integer | null     | No      | —                                                                                                                             | The unique identifier for the company associated with the group. |
| `email`                                   | string  | No       | —       | The email address associated with the group.                                                                                  |                                                                  |
| `enableAutomaticDispatchOfServiceRecords` | boolean | No       | —       | Determines if service records should be automatically dispatched. Only applicable if `canBeAssignedToServiceRecord` is `true` |                                                                  |
| `name`                                    | string  | Yes      | —       | The group's name.                                                                                                             |                                                                  |
| `receiveAutomaticSrEmailNotifications`    | boolean | No       | —       | Indicates whether the group receives automatic SR email notifications.                                                        |                                                                  |
| `supportLevel`                            | integer | No       | —       | A number representing the support level (from existing support levels).                                                       |                                                                  |
| `type`                                    | string  | Yes      | —       | The group type.                                                                                                               |                                                                  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "canBeAssignedToServiceRecord": {
        "type": "boolean",
        "description": "Indicates if the group can be assigned to a service record. Not applicable if `type` is set to `END_USERS`."
      },
      "companyId": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The unique identifier for the company associated with the group."
      },
      "email": {
        "type": "string",
        "description": "The email address associated with the group."
      },
      "enableAutomaticDispatchOfServiceRecords": {
        "type": "boolean",
        "description": "Determines if service records should be automatically dispatched. Only applicable if `canBeAssignedToServiceRecord` is `true`"
      },
      "name": {
        "type": "string",
        "description": "The group's name."
      },
      "receiveAutomaticSrEmailNotifications": {
        "type": "boolean",
        "description": "Indicates whether the group receives automatic SR email notifications."
      },
      "supportLevel": {
        "type": "integer",
        "description": "A number representing the support level (from existing support levels)."
      },
      "type": {
        "type": "string",
        "description": "The group type.",
        "enum": [
          "GENERAL",
          "ADMINISTRATORS",
          "END_USERS"
        ]
      }
    },
    "required": [
      "PCID",
      "name",
      "type"
    ]
  }
  ```
</Expandable>

***

## sysaid\_create\_webhook

Create a new webhook subscription

**Parameters:**

| Parameter     | Type      | Required | Default | Description                                      |
| ------------- | --------- | -------- | ------- | ------------------------------------------------ |
| `accountName` | string    | Yes      | —       | The name of the account to subscribe to          |
| `description` | string    | No       | —       | Optional description of the webhook subscription |
| `eventNames`  | string\[] | Yes      | —       | The names of the events to subscribe to          |
| `url`         | string    | Yes      | —       | The HTTPS URL that will receive webhook events   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "accountName": {
        "type": "string",
        "description": "The name of the account to subscribe to"
      },
      "description": {
        "type": "string",
        "description": "Optional description of the webhook subscription"
      },
      "eventNames": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The names of the events to subscribe to"
      },
      "url": {
        "type": "string",
        "description": "The HTTPS URL that will receive webhook events"
      }
    },
    "required": [
      "PCID",
      "accountName",
      "eventNames",
      "url"
    ]
  }
  ```
</Expandable>

***

## sysaid\_delete\_agent

Delete agent

**Parameters:**

| Parameter | Type    | Required | Default | Description                         |
| --------- | ------- | -------- | ------- | ----------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the agent. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the agent."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## sysaid\_delete\_end\_user

Delete end user

**Parameters:**

| Parameter | Type    | Required | Default | Description                            |
| --------- | ------- | -------- | ------- | -------------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the end user. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the end user."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## sysaid\_get\_agent

Get agent by ID

**Parameters:**

| Parameter | Type    | Required | Default | Description                         |
| --------- | ------- | -------- | ------- | ----------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the agent. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the agent."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## sysaid\_get\_end\_user

Get end user by ID

**Parameters:**

| Parameter | Type    | Required | Default | Description                            |
| --------- | ------- | -------- | ------- | -------------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the end user. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the end user."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## sysaid\_get\_group

Get group by ID

**Parameters:**

| Parameter | Type    | Required | Default | Description                         |
| --------- | ------- | -------- | ------- | ----------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the group. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the group."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## sysaid\_get\_group\_members

Get group members

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                                       |
| --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the group.                                               |
| `limit`   | integer | No       | —       | The number of records to return per page, up to 20.                               |
| `offset`  | integer | No       | —       | The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the group."
      },
      "limit": {
        "type": "integer",
        "description": "The number of records to return per page, up to 20."
      },
      "offset": {
        "type": "integer",
        "description": "The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1)."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## sysaid\_get\_service\_record\_by\_id

Get a service record by id

**Parameters:**

| Parameter  | Type    | Required | Default | Description                                                           |
| ---------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `recordId` | integer | Yes      | —       | The unique ID of the service record                                   |
| `fields`   | string  | No       | —       | A comma-separated list of service record fields to return in response |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "recordId": {
        "type": "integer",
        "description": "The unique ID of the service record"
      },
      "fields": {
        "type": "string",
        "description": "A comma-separated list of service record fields to return in response"
      }
    },
    "required": [
      "PCID",
      "recordId"
    ]
  }
  ```
</Expandable>

***

## sysaid\_get\_webhook\_subscriber\_by\_id

Get webhook subscriber by ID

**Parameters:**

| Parameter             | Type    | Required | Default | Description                                            |
| --------------------- | ------- | -------- | ------- | ------------------------------------------------------ |
| `id`                  | string  | Yes      | —       | The unique identifier (UUID) of the webhook subscriber |
| `include_event_names` | boolean | No       | —       | Whether to include event names in the response         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The unique identifier (UUID) of the webhook subscriber"
      },
      "include_event_names": {
        "type": "boolean",
        "description": "Whether to include event names in the response"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## sysaid\_remove\_agent\_from\_groups

Remove groups from agent's profile.

**Parameters:**

| Parameter  | Type       | Required | Default | Description                         |
| ---------- | ---------- | -------- | ------- | ----------------------------------- |
| `id`       | integer    | Yes      | —       | The unique identifier of the agent. |
| `groupIds` | integer\[] | Yes      | —       | A list of group IDs                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the agent."
      },
      "groupIds": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "A list of group IDs"
      }
    },
    "required": [
      "PCID",
      "id",
      "groupIds"
    ]
  }
  ```
</Expandable>

***

## sysaid\_remove\_end\_user\_from\_groups

Remove groups from user's profile.

**Parameters:**

| Parameter  | Type       | Required | Default | Description                            |
| ---------- | ---------- | -------- | ------- | -------------------------------------- |
| `id`       | integer    | Yes      | —       | The unique identifier of the end user. |
| `groupIds` | integer\[] | Yes      | —       | A list of group IDs                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the end user."
      },
      "groupIds": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "A list of group IDs"
      }
    },
    "required": [
      "PCID",
      "id",
      "groupIds"
    ]
  }
  ```
</Expandable>

***

## sysaid\_update\_agent

Update agent

**Parameters:**

| Parameter                | Type    | Required | Default | Description                                                    |                                                    |
| ------------------------ | ------- | -------- | ------- | -------------------------------------------------------------- | -------------------------------------------------- |
| `id`                     | integer | Yes      | —       | The unique identifier of the agent.                            |                                                    |
| `companyId`              | number  | null     | No      | —                                                              | Unique ID of the company the user works for        |
| `departmentId`           | number  | null     | No      | —                                                              | Unique ID of the department the user belongs to    |
| `displayName`            | string  | No       | —       | The user's display name                                        |                                                    |
| `enablePortalLogin`      | boolean | No       | —       | Enable login to the End User Portal                            |                                                    |
| `firstName`              | string  | No       | —       | The user's first name.                                         |                                                    |
| `isDisabled`             | boolean | No       | —       | Indicates if the user is disabled                              |                                                    |
| `language`               | string  | No       | —       | The language used by the user (default is "en")                |                                                    |
| `lastName`               | string  | No       | —       | The user's last name.                                          |                                                    |
| `locationId`             | number  | null     | No      | —                                                              | Unique ID of the location associated with the user |
| `managerId`              | integer | No       | —       | Manager Id                                                     |                                                    |
| `mobile`                 | string  | No       | —       | User's mobile number                                           |                                                    |
| `receiveSRNotifications` | boolean | No       | —       | Enable or disable automatic SR email notifications             |                                                    |
| `supervisorLevel`        | string  | No       | —       | Enable the user to have access to other's ssp tickets          |                                                    |
| `timezone`               | string  | No       | —       | The time zone of the user                                      |                                                    |
| `userEmail`              | string  | No       | —       | The user's email address.                                      |                                                    |
| `version`                | integer | Yes      | —       | The version number of the resource used for optimistic locking |                                                    |
| `workPhone`              | string  | No       | —       | User's work phone number/extension                             |                                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the agent."
      },
      "companyId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the company the user works for"
      },
      "departmentId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the department the user belongs to"
      },
      "displayName": {
        "type": "string",
        "description": "The user's display name"
      },
      "enablePortalLogin": {
        "type": "boolean",
        "description": "Enable login to the End User Portal"
      },
      "firstName": {
        "type": "string",
        "description": "The user's first name."
      },
      "isDisabled": {
        "type": "boolean",
        "description": "Indicates if the user is disabled"
      },
      "language": {
        "type": "string",
        "description": "The language used by the user (default is \"en\")"
      },
      "lastName": {
        "type": "string",
        "description": "The user's last name."
      },
      "locationId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the location associated with the user"
      },
      "managerId": {
        "type": "integer",
        "description": "Manager Id"
      },
      "mobile": {
        "type": "string",
        "description": "User's mobile number"
      },
      "receiveSRNotifications": {
        "type": "boolean",
        "description": "Enable or disable automatic SR email notifications"
      },
      "supervisorLevel": {
        "type": "string",
        "description": "Enable the user to have access to other's ssp tickets",
        "enum": [
          "NONE",
          "DEPARTMENT",
          "COMPANY"
        ]
      },
      "timezone": {
        "type": "string",
        "description": "The time zone of the user"
      },
      "userEmail": {
        "type": "string",
        "description": "The user's email address."
      },
      "version": {
        "type": "integer",
        "description": "The version number of the resource used for optimistic locking"
      },
      "workPhone": {
        "type": "string",
        "description": "User's work phone number/extension"
      }
    },
    "required": [
      "PCID",
      "id",
      "version"
    ]
  }
  ```
</Expandable>

***

## sysaid\_update\_end\_user

Update end user

**Parameters:**

| Parameter                | Type    | Required | Default | Description                                                    |                                                    |
| ------------------------ | ------- | -------- | ------- | -------------------------------------------------------------- | -------------------------------------------------- |
| `id`                     | integer | Yes      | —       | The unique identifier of the end user.                         |                                                    |
| `companyId`              | number  | null     | No      | —                                                              | Unique ID of the company the user works for        |
| `departmentId`           | number  | null     | No      | —                                                              | Unique ID of the department the user belongs to    |
| `displayName`            | string  | No       | —       | The user's display name                                        |                                                    |
| `enablePortalLogin`      | boolean | No       | —       | Enable login to the End User Portal                            |                                                    |
| `firstName`              | string  | No       | —       | The user's first name.                                         |                                                    |
| `isDisabled`             | boolean | No       | —       | Indicates if the user is disabled                              |                                                    |
| `language`               | string  | No       | —       | The language used by the user (default is "en")                |                                                    |
| `lastName`               | string  | No       | —       | The user's last name.                                          |                                                    |
| `locationId`             | number  | null     | No      | —                                                              | Unique ID of the location associated with the user |
| `managerId`              | integer | No       | —       | Manager Id                                                     |                                                    |
| `mobile`                 | string  | No       | —       | User's mobile number                                           |                                                    |
| `receiveSRNotifications` | boolean | No       | —       | Enable or disable automatic SR email notifications             |                                                    |
| `supervisorLevel`        | string  | No       | —       | Enable the user to have access to other's ssp tickets          |                                                    |
| `timezone`               | string  | No       | —       | The time zone of the user                                      |                                                    |
| `userEmail`              | string  | No       | —       | The user's email address.                                      |                                                    |
| `version`                | integer | Yes      | —       | The version number of the resource used for optimistic locking |                                                    |
| `workPhone`              | string  | No       | —       | User's work phone number/extension                             |                                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the end user."
      },
      "companyId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the company the user works for"
      },
      "departmentId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the department the user belongs to"
      },
      "displayName": {
        "type": "string",
        "description": "The user's display name"
      },
      "enablePortalLogin": {
        "type": "boolean",
        "description": "Enable login to the End User Portal"
      },
      "firstName": {
        "type": "string",
        "description": "The user's first name."
      },
      "isDisabled": {
        "type": "boolean",
        "description": "Indicates if the user is disabled"
      },
      "language": {
        "type": "string",
        "description": "The language used by the user (default is \"en\")"
      },
      "lastName": {
        "type": "string",
        "description": "The user's last name."
      },
      "locationId": {
        "type": [
          "number",
          "null"
        ],
        "description": "Unique ID of the location associated with the user"
      },
      "managerId": {
        "type": "integer",
        "description": "Manager Id"
      },
      "mobile": {
        "type": "string",
        "description": "User's mobile number"
      },
      "receiveSRNotifications": {
        "type": "boolean",
        "description": "Enable or disable automatic SR email notifications"
      },
      "supervisorLevel": {
        "type": "string",
        "description": "Enable the user to have access to other's ssp tickets",
        "enum": [
          "NONE",
          "DEPARTMENT",
          "COMPANY"
        ]
      },
      "timezone": {
        "type": "string",
        "description": "The time zone of the user"
      },
      "userEmail": {
        "type": "string",
        "description": "The user's email address."
      },
      "version": {
        "type": "integer",
        "description": "The version number of the resource used for optimistic locking"
      },
      "workPhone": {
        "type": "string",
        "description": "User's work phone number/extension"
      }
    },
    "required": [
      "PCID",
      "id",
      "version"
    ]
  }
  ```
</Expandable>

***

## sysaid\_update\_service\_record

Update a service record properties

**Parameters:**

| Parameter  | Type    | Required | Default | Description                                      |
| ---------- | ------- | -------- | ------- | ------------------------------------------------ |
| `recordId` | integer | Yes      | —       | The unique ID of the service record              |
| `body`     | object  | Yes      | —       | A list of service request's properties to update |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "recordId": {
        "type": "integer",
        "description": "The unique ID of the service record"
      },
      "body": {
        "type": "object",
        "description": "A list of service request's properties to update"
      }
    },
    "required": [
      "PCID",
      "recordId",
      "body"
    ]
  }
  ```
</Expandable>