Skip to content

Create Workspaces

Endpoint

http
POST /unified/ticketing/workspaces
Integrations supported
  • Planhat

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

Request Body

Refer Writing data using Unified APIs

name
string

The name of the workspace

Required in
  • Planhat
account_id
string

The unique identifier for the account.

Required in
  • Planhat
custom_fields
Supported in
  • Planhat
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

The ID of the workspace

Supported in
  • Planhat
name
string

The name of the workspace

Supported in
  • Planhat
status
string

The status of the workspace

All possible enum values:
  • active
  • inactive
description
string

The description of the workspace

created_at
string · date-time

The date and time the workspace was created

updated_at
string · date-time

The date and time the workspace was last updated

etag
string

The unique identifier for the specific version of the resource.

remote_data
object

Raw data returned from the remote API call.