Skip to main content
PUT
/
projects
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": 5,
  "name": "Sample Project (With Purchasing)",
  "code": {
    "client": {
      "id": 19,
      "name": "Sample Client",
      "data": {
        "notes": {
          "value": {
            "value": "This is a sample client"
          }
        },
        "account": {
          "value": {
            "vat": null,
            "terms": null,
            "currency": "USD",
            "lead_time": null,
            "credit_limit": null,
            "account_number": null,
            "registration_number": null
          }
        },
        "address": {
          "value": [
            {
              "id": 19,
              "city": "New York",
              "name": "Sample Client",
              "phone": "0123456789",
              "state": "New York",
              "country": "United States of America",
              "contacts": {
                "value": [
                  {
                    "id": 19,
                    "name": "Sample Client",
                    "note": "This is a sample client",
                    "email": "[email protected]",
                    "phone": "0123456789",
                    "position": null
                  }
                ]
              },
              "post_code": "10001",
              "address_line_1": "A street address",
              "address_line_2": null,
              "team_region_id": null,
              "default_billing_address": false
            }
          ]
        },
        "company_details": {
          "value": {
            "email": "[email protected]",
            "website": null,
            "language": null,
            "password": null,
            "user_name": null,
            "company_name": "Sample Client"
          }
        }
      },
      "addresses": [
        {
          "id": 19,
          "name": "Sample Client",
          "phone": "0123456789",
          "postcode": "10001",
          "address_line_1": "A street address",
          "address_line_2": null,
          "city": "New York",
          "state": "New York",
          "country": "United States of America"
        }
      ],
      "people": [
        {
          "id": 19,
          "name": "Sample Client",
          "email": "[email protected]",
          "phone": "0123456789",
          "position": null,
          "note": "This is a sample client"
        }
      ],
      "category": {
        "id": 3,
        "type": "client"
      },
      "billing_client": null,
      "categories": [
        {
          "id": 157,
          "name": "Cooking Equipment",
          "code": "",
          "key": "cooking_equipment",
          "children": []
        },
        {
          "id": 168,
          "name": "Banquet and Event Equipment",
          "code": "",
          "key": "banquet_and_event_equipment",
          "children": [
            {
              "id": 170,
              "name": "Buffet Stations and Display Tables",
              "code": "",
              "key": "buffet_stations_and_display_tables",
              "children": []
            },
            {
              "id": 171,
              "name": "Audiovisual Equipment",
              "code": "",
              "key": "audiovisual_equipment",
              "children": []
            }
          ]
        }
      ],
      "project_currency": {
        "enabled": true,
        "currency": {
          "id": 1,
          "iso_code": "USD",
          "name": "United States dollar"
        },
        "exchange_rates": [
          {
            "rate": 73.49,
            "exchange_currency": {
              "id": 4,
              "iso_code": "EUR",
              "name": "Euro"
            }
          },
          {
            "rate": 99.78,
            "exchange_currency": {
              "id": 15,
              "iso_code": "AUD",
              "name": "Australian dollar"
            }
          }
        ]
      },
      "project_users": [
        {
          "access": "admin",
          "user_id": 1
        },
        {
          "access": "edit",
          "user_id": 4
        },
        {
          "access": "edit",
          "user_id": 5
        }
      ]
    }
  }
}

Authorizations

authorization
string
header
required

Path Parameters

id
string
required

Body

application/json
name
string

The project name

code
string

The project number

client_id
integer
billing_client_id
integer
address_id
integer
category_ids
integer[]

The project schedule ids

project_users
object[]

Response

OK

id
integer

The unique identifier for the project.

name
string

The name of the project.

code
string | null

The number of the project.

client
object
billing_client
object
address
object
categories
object[]

The categories of the project.

project_currency
object
project_users
object[]

The project users of the project.