UpdateProjectStatus - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

status

enum<string>

required

Allowed values:

pipelineongoingcompletedcancelled

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

object (IProjectsDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string | null

required

projectKey

string | null

optional

title

string | null

required

client

optional

startDate

optional

endDate

optional

status

required

description

string | null

optional

participants

array[object (ICommonUser) {4}] | null

optional

order

object | null

optional

expenses

array [object {3}] | null

optional

files

array[string] | null

optional

currency

optional

budget

object | null

optional

isDeleted

boolean

optional

isArchived

boolean

optional

icon

string | null

optional

message

string

optional

Example

{
  "data": {
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "__v": 0,
    "_id": "string",
    "organizationId": "string",
    "projectKey": "string",
    "title": "string",
    "client": {
      "id": "string",
      "name": "string",
      "clientType": "business",
      "billingAddress": {
        "locationName": "string",
        "street1": "string",
        "street2": "string",
        "pincode": "string",
        "city": "string",
        "state": "string",
        "country": "string"
      },
      "contacts": [
        {
          "isPrimary": true,
          "salutation": "Mr.",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "workPhone": "string",
          "mobilePhone": "string",
          "designation": "string",
          "department": "string"
        }
      ],
      "shippingAddress": {
        "locationName": "string",
        "street1": "string",
        "street2": "string",
        "pincode": "string",
        "city": "string",
        "state": "string",
        "country": "string"
      },
      "tax": {
        "taxTreatment": "GST",
        "taxNumber": "string",
        "taxes": [
          {
            "id": "string",
            "name": "string",
            "percentage": 0
          }
        ]
      }
    },
    "startDate": {
      "estimated": "2019-08-24T14:15:22Z",
      "actual": "2019-08-24T14:15:22Z"
    },
    "endDate": {
      "estimated": "2019-08-24T14:15:22Z",
      "actual": "2019-08-24T14:15:22Z"
    },
    "status": "pipeline",
    "description": "string",
    "participants": [
      {
        "id": "string",
        "name": "string",
        "email": "string",
        "organizations": [
          {
            "organizationHashId": "string",
            "organizationId": "string",
            "role": "organization-admin",
            "teams": [
              "admin"
            ],
            "organizationName": "string",
            "organizationLogo": "string",
            "isActive": true
          }
        ]
      }
    ],
    "order": {
      "id": "string",
      "finalAmount": 0,
      "currency": {
        "name": "string",
        "symbol": "string"
      },
      "orderNumber": "string"
    },
    "expenses": [
      {
        "id": "string",
        "amount": 0,
        "currency": {
          "name": "string",
          "symbol": "string"
        }
      }
    ],
    "files": [
      "string"
    ],
    "currency": {
      "name": "string",
      "symbol": "string"
    },
    "budget": {
      "actual": 0,
      "estimated": 0
    },
    "isDeleted": true,
    "isArchived": true,
    "icon": "string"
  },
  "message": "string"
}

🟢200Success