Appearance

Update Projects ​

Endpoint ​

http
PATCH /unified/crm/projects/{id}
Integrations supported
  • Capsule
  • Insightly
  • Pipeliner
  • Planhat
  • Teamleader

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

Request Body ​

Refer Writing data using Unified APIs

name
string

The project's name

Required in
  • Teamleader
Supported in
  • Capsule
  • Insightly
  • Pipeliner
  • Planhat
account
object

The project's account

Supported in
  • Capsule
  • Pipeliner
  • Planhat
  • Teamleader
id
string

The account's unique identifier

name
string

The account name

contact
object[]

The project's contacts

Supported in
  • Capsule
  • Teamleader
id
string

The contact's unique identifier

name
string

The contact name

description
string

The project's description

Supported in
  • Capsule
  • Insightly
  • Pipeliner
  • Teamleader
tags
object[]

The project's tags

Supported in
  • Capsule
id
string

The tag's unique identifier

name
string

The tag's name

close_date
string · date-time

The date and time of the project's close date

Supported in
  • Capsule
  • Insightly
  • Pipeliner
custom_fields
Supported in
  • Capsule
  • Insightly
  • Planhat
opportunity
object[]

The project's opportunity

Supported in
  • Capsule
  • Teamleader
id
string

The opportunity's unique identifier

name
string

The opportunity name

status
string

The project's status

All possible enum values:
  • open
  • closed
  • not started
  • in progress
  • deferred
  • cancelled
  • abandoned
  • completed
Enum support by integration
  • Capsule
    • open
    • closed
  • Insightly
    • not started
    • in progress
    • deferred
    • cancelled
    • abandoned
    • completed
Supported in
  • Capsule
  • Insightly
amount
number

The project's amount

Supported in
  • Planhat
  • Teamleader
currency
string

The amount attribute's currency

Supported in
  • Planhat
  • Teamleader
owner
object

The project's owner

Supported in
  • Insightly
  • Pipeliner
  • Teamleader
id
string

The owner's unique identifier

name
string

The owner name

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 project's unique identifier

Supported in
  • Capsule
  • Insightly
  • Pipeliner
  • Planhat
name
string

The project's name

Supported in
  • Capsule
  • Insightly
  • Pipeliner
  • Planhat
description
string

The project's description

Supported in
  • Capsule
  • Insightly
  • Pipeliner
amount
number

The project's amount

Supported in
  • Planhat
currency
string

The amount attribute's currency

Supported in
  • Planhat
owner
object

The project's owner

Supported in
  • Capsule
  • Insightly
  • Pipeliner
id
string

The owner's unique identifier

name
string

The owner name

account
object

The project's account

Supported in
  • Capsule
  • Pipeliner
  • Planhat
id
string

The account's unique identifier

name
string

The account name

contact
object[]

The project's contacts

Supported in
  • Capsule
  • Pipeliner
id
string

The contact's unique identifier

name
string

The contact name

opportunity
object[]

The project's opportunity

Supported in
  • Capsule
  • Insightly
id
string

The opportunity's unique identifier

name
string

The opportunity name

stage
object

The project's stage

Supported in
  • Capsule
  • Insightly
id
string

The stage's unique identifier

name
string

The stage's name

status
string

The project's status

Supported in
  • Capsule
  • Insightly
  • Pipeliner
tags
object[]

The project's tags

Supported in
  • Capsule
  • Insightly
id
string

The tag's unique identifier

name
string

The tag's name

last_activity_at
string · date-time

The date and time of the project's last activity

Supported in
  • Capsule
  • Insightly
close_date
string · date-time

The date and time of the project's close date

Supported in
  • Capsule
  • Insightly
  • Pipeliner
created_at
string · date-time

The date and time of the project's creation

Supported in
  • Capsule
  • Insightly
  • Pipeliner
  • Planhat
updated_at
string · date-time

The date and time of the project's last update

Supported in
  • Capsule
  • Insightly
  • Pipeliner
  • Planhat
remote_data
object

Raw data returned from the remote API call.