Appearance

Update Collections ​

Endpoint ​

http
PATCH /unified/ticketing/collections/{id}
Integrations supported
  • Hive
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Quickbase for Project Management
  • Todoist
  • Wrike
  • Zoho Projects

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
organization
object
Supported in
  • Zoho Projects
id
string

The unique identifier for a organization.

workspace
object
Required in
  • Zoho Projects
id
string

The unique identifier for a workspace

name
string

The name of the workspace

etag
string

The unique identifier for the specific version of the resource.

Required in
  • Microsoft Planner
type
string

The type of the collection

All possible enum values:
  • component
  • epic
  • product
  • project
  • section
Enum support by integration
  • Pivotal Tracker
    • project
    • epic
  • Todoist
    • project
    • section
  • Productboard
    • component
    • product
Required in
  • Pivotal Tracker
  • Productboard
  • Todoist

Request Body ​

Refer Writing data using Unified APIs

custom_fields
Supported in
  • Planhat
  • Quickbase for Project Management
  • Wrike
name
string

The name of the collection

Required in
  • Zoho Projects
Supported in
  • Hive
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Todoist
parent_collection_id
string

The parent collection id

Required in
  • Zoho Projects
flag
string
All possible enum values:
  • internal
  • external
Enum support by integration
  • Zoho Projects
    • internal
    • external
Required in
  • Zoho Projects
status
string

The status of the collection.

All possible enum values:
  • completed
  • active
Enum support by integration
  • Zoho Projects
    • completed
    • active
Required in
  • Zoho Projects
description
string

The description of the collection

Supported in
  • Hive
  • Pivotal Tracker
  • Productboard
  • Wrike
title
Supported in
  • Wrike
parent_collection
object

Set this value when type is component.

Supported in
  • Productboard
id
string
REQUIRED · 
type
REQUIRED · 
All possible enum values:
  • component
  • product
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The unique identifier for a collection

Supported in
  • Hive
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Quickbase for Project Management
  • Todoist
  • Wrike
  • Zoho Projects
name
string

The name of the collection

Supported in
  • Hive
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Todoist
  • Wrike
  • Zoho Projects
description
string

The description of the collection

Supported in
  • Hive
  • Pivotal Tracker
  • Productboard
  • Wrike
type
string

The type of the collection

Supported in
  • Pivotal Tracker
  • Todoist
  • Zoho Projects
parent_collection_id
string

The parent collection id

Supported in
  • Pivotal Tracker
  • Productboard
  • Todoist
  • Zoho Projects
urls
object[]

The URLs of the collection

Supported in
  • Productboard
  • Todoist
  • Wrike
  • Zoho Projects
url
string

The URL of the collection

workspace
object
Supported in
  • Hive
  • Microsoft Planner
  • Zoho Projects
id
string

The unique identifier for a workspace

name
string

The name of the workspace

created_at
string · date-time

The date and time when the collection was created

Supported in
  • Hive
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Wrike
  • Zoho Projects
updated_at
string · date-time

The date and time when the collection was updated

Supported in
  • Hive
  • Pivotal Tracker
  • Productboard
  • Wrike
  • Zoho Projects
etag
string

The unique identifier for the specific version of the resource.

Supported in
  • Microsoft Planner
remote_data
object

Raw data returned from the remote API call.