> ## 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.
# safetyculture-actions
> SafetyCulture Actions - create, update, and manage corrective actions and timelines
**Server path:** `/safetyculture-actions` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| [`safetyculture_actions_customer_configuration_service_get_action_labels`](#safetyculture_actions_customer_configuration_service_get_action_labels) | Get all action labels |
| [`safetyculture_actions_scheduling_service_create_new_schedule`](#safetyculture_actions_scheduling_service_create_new_schedule) | Create a new schedule |
| [`safetyculture_actions_service_create_action`](#safetyculture_actions_service_create_action) | Create an action |
| [`safetyculture_actions_service_create_action_shared_link`](#safetyculture_actions_service_create_action_shared_link) | Create an action link |
| [`safetyculture_actions_service_delete_actions`](#safetyculture_actions_service_delete_actions) | Delete actions (Bulk) |
| [`safetyculture_actions_service_get_action`](#safetyculture_actions_service_get_action) | Get an Action |
| [`safetyculture_actions_service_get_action_shared_link`](#safetyculture_actions_service_get_action_shared_link) | Get an action link |
| [`safetyculture_actions_service_get_actions`](#safetyculture_actions_service_get_actions) | List actions |
| [`safetyculture_actions_service_revoke_action_shared_link`](#safetyculture_actions_service_revoke_action_shared_link) | Delete an action link |
| [`safetyculture_actions_service_update_action_labels`](#safetyculture_actions_service_update_action_labels) | Updates the labels associated with an action |
| [`safetyculture_actions_service_update_asset`](#safetyculture_actions_service_update_asset) | Update the asset of an action |
| [`safetyculture_actions_service_update_assignees`](#safetyculture_actions_service_update_assignees) | Update the assignees of an action |
| [`safetyculture_actions_service_update_description`](#safetyculture_actions_service_update_description) | Update the description of an action |
| [`safetyculture_actions_service_update_due_at`](#safetyculture_actions_service_update_due_at) | Update the due date of an action |
| [`safetyculture_actions_service_update_priority`](#safetyculture_actions_service_update_priority) | Update the priority of an action |
| [`safetyculture_actions_service_update_site`](#safetyculture_actions_service_update_site) | Update the site of an action |
| [`safetyculture_actions_service_update_status`](#safetyculture_actions_service_update_status) | Update the status of an action |
| [`safetyculture_actions_service_update_title`](#safetyculture_actions_service_update_title) | Update the title of an action |
| [`safetyculture_actions_timeline_service_add_comment`](#safetyculture_actions_timeline_service_add_comment) | Add comment to timeline |
| [`safetyculture_actions_timeline_service_get_timeline`](#safetyculture_actions_timeline_service_get_timeline) | List timeline events |
***
## safetyculture\_actions\_customer\_configuration\_service\_get\_action\_labels
Get all action labels
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## safetyculture\_actions\_scheduling\_service\_create\_new\_schedule
Create a new schedule
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `assignment` | object | Yes | — | Specifies which users are assigned to complete the work. |
| `completion_rule` | string | No | — | Completion rule for the schedule. Determines how many assigned users must complete the work for an occurrence to be considered complete. Defaults to COMPLETION\_RULE\_ANY (any single assigned user can complete it) if not specified. |
| `recurrence` | object | Yes | — | The recurrence pattern that defines when and how frequently the scheduled event occurs. |
| `target` | object | No | — | Specifies which sites or assets this schedule applies to. When set, a separate occurrence is created for each target (site or asset) at each recurrence. When not set, the schedule creates occurrences directly for the assigned users. |
| `title` | string | Yes | — | Title of the schedule. |
| `work_type` | object | No | — | The work to be done as part of the schedule. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assignment": {
"type": "object",
"description": "Specifies which users are assigned to complete the work.",
"properties": {
"users": {
"type": "object",
"description": "Assign to specific users."
},
"groups": {
"type": "object",
"description": "Assign to members of a group."
},
"site_members": {
"type": "object",
"description": "Assign schedule to all members of the site(s) from the target."
},
"site_members_in_group": {
"type": "object",
"description": "Assign to users who are both site members AND in a specific group."
}
}
},
"completion_rule": {
"type": "string",
"description": "Completion rule for the schedule. Determines how many assigned users must complete the work for an occurrence to be considered complete. Defaults to COMPLETION_RULE_ANY (any single assigned user can complete it) if not specified.",
"enum": [
"COMPLETION_RULE_UNSPECIFIED",
"COMPLETION_RULE_ANY",
"COMPLETION_RULE_ALL"
]
},
"recurrence": {
"type": "object",
"description": "The recurrence pattern that defines when and how frequently the scheduled event occurs.",
"properties": {
"dtstart_rrule": {
"type": "string",
"description": "Examples: - \"DTSTART:20240101T140000Z\\nRRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR\" (UTC timezone) - \"DTSTART;TZID=America/New_York:20240101T140000\\nRRULE:FREQ=DAILY;INTERVAL=1\" (with timezone)"
},
"duration": {
"type": "string",
"description": "Duration in ISO 8601 format (e.g., \"PT1H\"). Defines the window from start to due."
},
"use_site_timezone": {
"type": "boolean",
"description": "When true, use each target site's timezone instead of the RRULE timezone. Only applicable when target is sites or assets (uses the asset's parent site timezone). When enabled, any timezone specified in the RRULE will be ignored and set to the default time, UTC."
},
"late_submission_rule": {
"type": "object",
"description": "The conditions under which users can submit work late for each occurrence. When not set, late submission is not allowed."
}
},
"required": [
"dtstart_rrule",
"duration"
]
},
"target": {
"type": "object",
"description": "Specifies which sites or assets this schedule applies to. When set, a separate occurrence is created for each target (site or asset) at each recurrence. When not set, the schedule creates occurrences directly for the assigned users.",
"properties": {
"sites": {
"type": "object",
"description": "Target specific sites."
},
"assets": {
"type": "object",
"description": "Target specific assets."
}
}
},
"title": {
"type": "string",
"description": "Title of the schedule."
},
"work_type": {
"type": "object",
"description": "The work to be done as part of the schedule.",
"properties": {
"inspection": {
"type": "object",
"description": "Inspection work configuration."
}
}
}
},
"required": [
"PCID",
"assignment",
"recurrence",
"title"
]
}
```
***
## safetyculture\_actions\_service\_create\_action
Create an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `asset_id` | string | No | — | ID of the Asset associated with the action |
| `collaborators` | object\[] | No | — | The collaborators involved into this action. |
| `created_at` | string | No | — | Date and time this action was created. |
| `description` | string | No | — | Description of the action (maximum 30000 characters). |
| `due_at` | string | No | — | Date/time this action is due |
| `field_values` | object\[] | No | — | Array of custom fields and their values to create with the action. |
| `inspection_id` | string | No | — | ID of the inspection the action belongs to If not set, this action is a standalone action and the inspection ID will be null. |
| `inspection_item_id` | string | No | — | ID of the item in the inspection associated with the action |
| `label_ids` | string\[] | No | — | IDs of the labels associated with the action. |
| `priority_id` | string | No | — | ID of the action's priority If not set, this action will be stored with the default priority(none). |
| `references` | object\[] | No | — | Array of references attached to this action. |
| `site_id` | string | No | — | ID of the Site associated with the action. |
| `status_id` | string | No | — | ID of the action's status If not set, this action will be stored with the default status(to do). |
| `task_id` | string | No | — | The unique identifier of the action If not provided, UUID will be generated server side. |
| `template_id` | string | No | — | If a template ID is provided then an inspection ID must be provided. If not set, this action is a standalone action and the template ID will be null. |
| `template_ids` | string\[] | No | — | The list of templates to be linked to the action. |
| `title` | string | Yes | — | Required. Title of the action Title is limited to only 255 characters max. |
| `type` | object | No | — | The type to create an action in. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"asset_id": {
"type": "string",
"description": "ID of the Asset associated with the action"
},
"collaborators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collaborator_id": {
"type": "string",
"description": "A UUID uniquely identifying this collaborator."
},
"collaborator_type": {
"type": "string",
"enum": [
"USER",
"GROUP",
"EXTERNAL_USER",
"CONTRIBUTOR"
],
"description": "The type of the collaborator i.e. group or user."
},
"assigned_role": {
"type": "string",
"enum": [
"ASSIGNEE",
"CREATOR"
],
"description": "The role of the collaborator in this task."
},
"user": {
"type": "object",
"description": "Collaborator details for an authenticated user."
},
"group": {
"type": "object",
"description": "Collaborator details for a group."
},
"external_user": {
"type": "object",
"description": "Collaborator details for an external user."
},
"contributor": {
"type": "object",
"description": "Collaborator details for a contributor."
}
}
},
"description": "The collaborators involved into this action."
},
"created_at": {
"type": "string",
"description": "Date and time this action was created."
},
"description": {
"type": "string",
"description": "Description of the action (maximum 30000 characters)."
},
"due_at": {
"type": "string",
"description": "Date/time this action is due"
},
"field_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "string",
"description": "A global unique identifier for a field."
},
"string_value": {
"type": "string",
"description": "The string value of a field."
},
"money_value": {
"type": "object",
"description": "The money value of a field."
},
"timestamp_value": {
"type": "string",
"format": "date-time",
"description": "The timestamp value of a field."
},
"integer_value": {
"type": "string",
"format": "int64",
"description": "The integer value of a field. Signed, 64-bit integer."
},
"address_location_value": {
"type": "object",
"description": "The address location value of a field."
},
"contact_details_value": {
"type": "object",
"description": "The contact details value of a field."
}
}
},
"description": "Array of custom fields and their values to create with the action."
},
"inspection_id": {
"type": "string",
"description": "ID of the inspection the action belongs to If not set, this action is a standalone action and the inspection ID will be null."
},
"inspection_item_id": {
"type": "string",
"description": "ID of the item in the inspection associated with the action"
},
"label_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of the labels associated with the action."
},
"priority_id": {
"type": "string",
"description": "ID of the action's priority If not set, this action will be stored with the default priority(none)."
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SENSOR",
"SENSOR_ALERT",
"INSPECTION",
"INCIDENT",
"SCHEDULE",
"ACTION",
"LINKED_INSPECTION",
"ASSET_MAINTENANCE_PLAN"
],
"description": "Required. Reference Type."
},
"id": {
"type": "string",
"description": "Required. Reference ID."
},
"inspection_context": {
"type": "object",
"description": "Inspection Context"
},
"sensor_alert_context": {
"type": "object",
"description": "Sensor Alert Context"
},
"sensor_context": {
"type": "object",
"description": "Sensor Context"
},
"incident_context": {
"type": "object",
"description": "Incident Context"
},
"action_context": {
"type": "object",
"description": "Action Context"
},
"linked_inspection_context": {
"type": "object",
"description": "Context of an inspection started from a template associated with the action."
},
"asset_maintenance_plan_context": {
"type": "object",
"description": "Asset Maintenance Plan Context"
}
}
},
"description": "Array of references attached to this action."
},
"site_id": {
"type": "string",
"description": "ID of the Site associated with the action."
},
"status_id": {
"type": "string",
"description": "ID of the action's status If not set, this action will be stored with the default status(to do)."
},
"task_id": {
"type": "string",
"description": "The unique identifier of the action If not provided, UUID will be generated server side."
},
"template_id": {
"type": "string",
"description": "If a template ID is provided then an inspection ID must be provided. If not set, this action is a standalone action and the template ID will be null."
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of templates to be linked to the action."
},
"title": {
"type": "string",
"description": "Required. Title of the action Title is limited to only 255 characters max."
},
"type": {
"type": "object",
"description": "The type to create an action in.",
"properties": {
"type": {
"type": "string",
"description": "The type associated with an action. We currently only support one type: `Action`.",
"enum": [
"TASK_TYPE_ACTION",
"TASK_TYPE_CUSTOM"
]
},
"id": {
"type": "string",
"description": "The unique identifier of a type."
},
"name": {
"type": "string",
"description": "The name of a type."
}
}
}
},
"required": [
"PCID",
"title"
]
}
```
***
## safetyculture\_actions\_service\_create\_action\_shared\_link
Create an action link
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------- |
| `task_id` | string | Yes | — | Required. The unique identifier for the action |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The unique identifier for the action"
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_actions\_service\_delete\_actions
Delete actions (Bulk)
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | -------------------------------------------------------- |
| `ids` | string\[] | Yes | — | The list of action ids to be deleted |
| `modified_at` | string | No | — | Optional. The UTC time and date the deletion took place. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of action ids to be deleted"
},
"modified_at": {
"type": "string",
"description": "Optional. The UTC time and date the deletion took place."
}
},
"required": [
"PCID",
"ids"
]
}
```
***
## safetyculture\_actions\_service\_get\_action
Get an Action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------- |
| `id` | string | Yes | — | ID to query data for |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "ID to query data for"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## safetyculture\_actions\_service\_get\_action\_shared\_link
Get an action link
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------- |
| `task_id` | string | Yes | — | Required. The unique identifier for the action |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The unique identifier for the action"
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_actions\_service\_get\_actions
List actions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `inspection_id` | string | No | — | Optional. The ID of the inspection the action belongs to. Deprecated, inspectionID in `filters` should be used instead. |
| `offset` | integer | No | — | Optional. Offset from where on the actions will be listed. |
| `page_size` | integer | No | — | Optional. Number of actions to be returned in a single request. Maximum 100. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. For example: '20'. |
| `page_token` | string | No | — | Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call. For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='. |
| `sort_direction` | string | No | — | Optional. Direction for sorting. |
| `sort_field` | string | No | — | Optional. Which field to use for sorting. |
| `task_filters` | object\[] | No | — | Optional. The array of filters to apply in your request. You can apply multiple filters in a single request. |
| `without_count` | boolean | No | — | Optional. If true, will not return the count of actions. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"inspection_id": {
"type": "string",
"description": "Optional. The ID of the inspection the action belongs to. Deprecated, inspectionID in `filters` should be used instead."
},
"offset": {
"type": "integer",
"description": "Optional. Offset from where on the actions will be listed."
},
"page_size": {
"type": "integer",
"description": "Optional. Number of actions to be returned in a single request. Maximum 100. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. For example: '20'."
},
"page_token": {
"type": "string",
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call. For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='."
},
"sort_direction": {
"type": "string",
"description": "Optional. Direction for sorting.",
"enum": [
"ASC",
"DESC"
]
},
"sort_field": {
"type": "string",
"description": "Optional. Which field to use for sorting.",
"enum": [
"PRIORITY",
"DATE_DUE",
"CREATED_AT",
"MODIFIED_AT"
]
},
"task_filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the status_id should be one of the value provided."
},
"priority_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the priority_id should be one of the value provided."
},
"site_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the site_id should be one of the value provided."
},
"template_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the template_id should be one of the value provided."
},
"inspection_item_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the inspection_item_id should be one of the value provided."
},
"inspection_id": {
"type": "object",
"description": "Operator: Can be FILTER_OPERATOR_IN OR FILTER_OPERATOR_NOT_IN. Value: OR relation, represents the inspection_id should be one of the value provided."
},
"creator_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the creator_id should be one of the value provided."
},
"reference": {
"type": "object",
"description": "@deprecated. use References field instead."
},
"created_at": {
"type": "object",
"description": "The date created timestamp"
},
"modified_at": {
"type": "object",
"description": "The date last modified timetstamp"
},
"collaborators": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the assignee_id should be one of the value provided."
},
"due_at": {
"type": "object",
"description": "time duration filter."
},
"title": {
"type": "object",
"description": "text search filter."
},
"description": {
"type": "object",
"description": "text search filter."
},
"asset_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the asset_id should be one of the value provided."
},
"label_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the label_id should be one of the value provided."
},
"task_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the task_id should be one of the value provided."
},
"references": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the reference_id should be one of the value provided."
},
"type_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: The list of type ids to be filtered on."
},
"asset_type_id": {
"type": "object",
"description": "Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the asset_type_id should be one of the value provided."
}
}
},
"description": "Optional. The array of filters to apply in your request. You can apply multiple filters in a single request."
},
"without_count": {
"type": "boolean",
"description": "Optional. If true, will not return the count of actions."
}
},
"required": [
"PCID"
]
}
```
***
## safetyculture\_actions\_service\_revoke\_action\_shared\_link
Delete an action link
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------- |
| `task_id` | string | Yes | — | Required. The unique identifier for the action |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The unique identifier for the action"
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_actions\_service\_update\_action\_labels
Updates the labels associated with an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `action_id` | string | Yes | — | action\_id is the ID of the action to be updated. |
| `label_ids` | string\[] | No | — | The list of label IDs to associate with the action. Multiple labels can be added. Note: Sending an empty list for `label_ids` will remove all labels currently associated with the action. |
| `modified_at` | string | No | — | Date and time this label was modified. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"action_id": {
"type": "string",
"description": "action_id is the ID of the action to be updated."
},
"label_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of label IDs to associate with the action. Multiple labels can be added. Note: Sending an empty list for `label_ids` will remove all labels currently associated with the action."
},
"modified_at": {
"type": "string",
"description": "Date and time this label was modified."
}
},
"required": [
"PCID",
"action_id"
]
}
```
***
## safetyculture\_actions\_service\_update\_asset
Update the asset of an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `asset_id` | object | No | — | Optional. The new asset UUID for the task. If this is empty, the asset will be unset. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"asset_id": {
"type": "object",
"description": "Optional. The new asset UUID for the task. If this is empty, the asset will be unset.",
"properties": {
"value": {
"type": "string",
"description": "The value value"
}
}
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_actions\_service\_update\_assignees
Update the assignees of an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ------------------------------------------------------------ |
| `task_id` | string | Yes | — | Required. The unique identifier for the task to be updated. |
| `assignees` | object\[] | Yes | — | Required. The assignees to be assigned to the task. |
| `modified_at` | string | No | — | Optional. The UTC time and date the modification took place. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The unique identifier for the task to be updated."
},
"assignees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collaborator_id": {
"type": "string",
"description": "A UUID uniquely identifying this collaborator."
},
"collaborator_type": {
"type": "string",
"enum": [
"USER",
"GROUP",
"EXTERNAL_USER",
"CONTRIBUTOR"
],
"description": "The type of the collaborator i.e. group or user."
},
"assigned_role": {
"type": "string",
"enum": [
"ASSIGNEE",
"CREATOR"
],
"description": "The role of the collaborator in this task."
},
"user": {
"type": "object",
"description": "Collaborator details for an authenticated user."
},
"group": {
"type": "object",
"description": "Collaborator details for a group."
},
"external_user": {
"type": "object",
"description": "Collaborator details for an external user."
},
"contributor": {
"type": "object",
"description": "Collaborator details for a contributor."
}
}
},
"description": "Required. The assignees to be assigned to the task."
},
"modified_at": {
"type": "string",
"description": "Optional. The UTC time and date the modification took place."
}
},
"required": [
"PCID",
"task_id",
"assignees"
]
}
```
***
## safetyculture\_actions\_service\_update\_description
Update the description of an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `description` | string | Yes | — | Required. The new description for the task. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"description": {
"type": "string",
"description": "Required. The new description for the task."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
}
},
"required": [
"PCID",
"task_id",
"description"
]
}
```
***
## safetyculture\_actions\_service\_update\_due\_at
Update the due date of an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated |
| `due_at` | string | No | — | Optional. Date/time this task is due. If this is empty, "due at" will be unset. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated"
},
"due_at": {
"type": "string",
"description": "Optional. Date/time this task is due. If this is empty, \"due at\" will be unset."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_actions\_service\_update\_priority
Update the priority of an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
| `priority_id` | string | Yes | — | Required. The new priority UUID for the task. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
},
"priority_id": {
"type": "string",
"description": "Required. The new priority UUID for the task."
}
},
"required": [
"PCID",
"task_id",
"priority_id"
]
}
```
***
## safetyculture\_actions\_service\_update\_site
Update the site of an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
| `site_id` | object | No | — | Optional. The new site UUID for the task. If this is empty, the site will be unset. Use the `GetFolders` endpoint to get the available sites. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
},
"site_id": {
"type": "object",
"description": "Optional. The new site UUID for the task. If this is empty, the site will be unset. Use the `GetFolders` endpoint to get the available sites.",
"properties": {
"value": {
"type": "string",
"description": "The value value"
}
}
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_actions\_service\_update\_status
Update the status of an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The ID of the action or issue you're updating. |
| `modified_at` | string | No | — | Optional. The UTC time and date the modification took place. |
| `status_id` | string | Yes | — | Required. The ID of the status you're updating the action or issue to. An issue can be in an "Open" or "Resolved" status, where each status is represented by hardcoded UUID values. Issue statuses: - Open: `547ed646-5e34-4732-bb54-a199d304368a`. - Resolved: `450484b1-56cd-4784-9b49-a3cf97d0c0ad`. An action can be in a "To do", "In progress", "Complete", or "Can't do" status, where each status is represented by hardcoded UUID values. Action statuses: - To do: `17e793a1-26a3-4ecd-99ca-f38ecc6eaa2e`. - In progress: `20ce0cb1-387a-47d4-8c34-bc6fd3be0e27`. - Complete: `7223d809-553e-4714-a038-62dc98f3fbf3`. - Can't do: `06308884-41c2-4ee0-9da7-5676647d3d75`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The ID of the action or issue you're updating."
},
"modified_at": {
"type": "string",
"description": "Optional. The UTC time and date the modification took place."
},
"status_id": {
"type": "string",
"description": "Required. The ID of the status you're updating the action or issue to. An issue can be in an \"Open\" or \"Resolved\" status, where each status is represented by hardcoded UUID values. Issue statuses: - Open: `547ed646-5e34-4732-bb54-a199d304368a`. - Resolved: `450484b1-56cd-4784-9b49-a3cf97d0c0ad`. An action can be in a \"To do\", \"In progress\", \"Complete\", or \"Can't do\" status, where each status is represented by hardcoded UUID values. Action statuses: - To do: `17e793a1-26a3-4ecd-99ca-f38ecc6eaa2e`. - In progress: `20ce0cb1-387a-47d4-8c34-bc6fd3be0e27`. - Complete: `7223d809-553e-4714-a038-62dc98f3fbf3`. - Can't do: `06308884-41c2-4ee0-9da7-5676647d3d75`."
}
},
"required": [
"PCID",
"task_id",
"status_id"
]
}
```
***
## safetyculture\_actions\_service\_update\_title
Update the title of an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
| `title` | string | Yes | — | Required. The new title for the task. The title must be between 0 and 255 characters. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
},
"title": {
"type": "string",
"description": "Required. The new title for the task. The title must be between 0 and 255 characters."
}
},
"required": [
"PCID",
"task_id",
"title"
]
}
```
***
## safetyculture\_actions\_timeline\_service\_add\_comment
Add comment to timeline
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------------------------------------------- |
| `comment` | string | Yes | — | Required. The content of the comment. |
| `created_at` | string | No | — | Optional. Date/time this comment was added. |
| `event_id` | string | No | — | Optional. The unique identifier for the event. This will be auto-generated if omitted. |
| `task_id` | string | Yes | — | Required. The UUID for the task the comment is being added to. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"comment": {
"type": "string",
"description": "Required. The content of the comment."
},
"created_at": {
"type": "string",
"description": "Optional. Date/time this comment was added."
},
"event_id": {
"type": "string",
"description": "Optional. The unique identifier for the event. This will be auto-generated if omitted."
},
"task_id": {
"type": "string",
"description": "Required. The UUID for the task the comment is being added to."
}
},
"required": [
"PCID",
"comment",
"task_id"
]
}
```
***
## safetyculture\_actions\_timeline\_service\_get\_timeline
List timeline events
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task whose timeline will be retrieved. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task whose timeline will be retrieved."
}
},
"required": [
"PCID",
"task_id"
]
}
```