Projects

Updates a project. Send only the fields you want to change.

An omitted field is left alone; re-sending a value the project already holds is a no-op rather than an error, and records no activity. Sending nothing at all is a 400.

Lists replace outright: send an empty array to clear one. LeadAssigneeId: 0 removes the lead, and ClearTargetDate: true removes the target date.

ClosedOn backdates the close of a project being migrated from another system, and also becomes its UpdatedOn. It is only accepted for a project that is Closed - already, or by this same request - and never for a future date or one before the project was created. Omit it and closing a project stamps the time of the change; reopening a Closed project clears it. Completed is reached automatically and carries no date.

Two field pairings are enforced because the data requires them: moving the project to a different ClientId needs a LocationId in that client and clears the shared contacts, and a technician cannot be both the lead and a watcher.

PATCH

projects

{projectId}

Updates a project. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/projects/{projectId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Title": "<string>",
  "Description": "<string>",
  "ClientId": 123,
  "LocationId": 123,
  "SharedWithContactIds": [
    123
  ],
  "TypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "TagIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "LeadAssigneeId": 123,
  "WatcherIds": [
    123
  ],
  "GroupIds": [
    123
  ],
  "TargetDate": "2023-11-07T05:31:56Z",
  "ClearTargetDate": true,
  "StatusId": 123,
  "StatusReason": "<string>",
  "ClosedOn": "2023-11-07T05:31:56Z",
  "UpdatedByName": "<string>"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/projects/{projectId}"

payload = {
    "Title": "<string>",
    "Description": "<string>",
    "ClientId": 123,
    "LocationId": 123,
    "SharedWithContactIds": [123],
    "TypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "TagIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "LeadAssigneeId": 123,
    "WatcherIds": [123],
    "GroupIds": [123],
    "TargetDate": "2023-11-07T05:31:56Z",
    "ClearTargetDate": True,
    "StatusId": 123,
    "StatusReason": "<string>",
    "ClosedOn": "2023-11-07T05:31:56Z",
    "UpdatedByName": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Title: '<string>',
    Description: '<string>',
    ClientId: 123,
    LocationId: 123,
    SharedWithContactIds: [123],
    TypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    TagIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    LeadAssigneeId: 123,
    WatcherIds: [123],
    GroupIds: [123],
    TargetDate: '2023-11-07T05:31:56Z',
    ClearTargetDate: true,
    StatusId: 123,
    StatusReason: '<string>',
    ClosedOn: '2023-11-07T05:31:56Z',
    UpdatedByName: '<string>'
  })
};

fetch('https://api.usw.gorelo.io/v1/projects/{projectId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/projects/{projectId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'Title' => '<string>',
    'Description' => '<string>',
    'ClientId' => 123,
    'LocationId' => 123,
    'SharedWithContactIds' => [
        123
    ],
    'TypeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'TagIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'LeadAssigneeId' => 123,
    'WatcherIds' => [
        123
    ],
    'GroupIds' => [
        123
    ],
    'TargetDate' => '2023-11-07T05:31:56Z',
    'ClearTargetDate' => true,
    'StatusId' => 123,
    'StatusReason' => '<string>',
    'ClosedOn' => '2023-11-07T05:31:56Z',
    'UpdatedByName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/projects/{projectId}"

	payload := strings.NewReader("{\n  \"Title\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"LeadAssigneeId\": 123,\n  \"WatcherIds\": [\n    123\n  ],\n  \"GroupIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"ClearTargetDate\": true,\n  \"StatusId\": 123,\n  \"StatusReason\": \"<string>\",\n  \"ClosedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedByName\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.usw.gorelo.io/v1/projects/{projectId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Title\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"LeadAssigneeId\": 123,\n  \"WatcherIds\": [\n    123\n  ],\n  \"GroupIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"ClearTargetDate\": true,\n  \"StatusId\": 123,\n  \"StatusReason\": \"<string>\",\n  \"ClosedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedByName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/projects/{projectId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Title\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"LeadAssigneeId\": 123,\n  \"WatcherIds\": [\n    123\n  ],\n  \"GroupIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"ClearTargetDate\": true,\n  \"StatusId\": 123,\n  \"StatusReason\": \"<string>\",\n  \"ClosedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedByName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

授权

X-API-Key

string

header

必填

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

路径参数

projectId

string<uuid>

必填

Project to update.

请求体

Fields to change.

Request body for updating a project. Every field is optional - send only what you want to change. An omitted field leaves the stored value alone; sending nothing at all is a 400.

Title

string | null

New project title.

Description

string | null

New description. Send an empty string to remove it.

ClientId

integer<int64> | null

Move the project to a different client. Clears the shared contacts, because a contact belongs to the client it came from - the app does the same. Send LocationId with it: a location belongs to a client.

LocationId

integer<int64> | null

New client location.

SharedWithContactIds

integer<int64>[] | null

Replaces the contacts the project is shared with. Empty array clears them.

TypeId

string<uuid> | null

New project type.

TagIds

string<uuid>[] | null

Replaces the tags. Empty array clears them.

LeadAssigneeId

integer<int64> | null

New lead assignee. Send 0 to remove the lead.

WatcherIds

integer<int64>[] | null

Replaces the watchers. Empty array clears them.

GroupIds

integer<int64>[] | null

Replaces the technician groups the project belongs to.

TargetDate

string<date-time> | null

New target date (UTC). To remove it, send ClearTargetDate.

ClearTargetDate

boolean | null

Set true to remove the due date.

StatusId

integer<int64> | null

New status: 1 Not started, 2 In progress, 3 On hold, 4 Completed, 5 Closed. Completed is normally reached automatically once every task is Done; Closed is the manual end state and stamps ClosedOn. Moving a Closed project to any other status clears it.

StatusReason

string | null

Free-text reason recorded with the status. Only read when StatusId is sent.

ClosedOn

string<date-time> | null

The date the project was closed (UTC), for recording the real close date of a project migrated from another system. The project must already be Closed, or be moved into that status by this same request. Must not be in the future or earlier than the project's CreatedOn. A supplied date also becomes the project's UpdatedOn. Omit it to leave the date untouched - closing a project normally stamps it with the time of the change.

UpdatedByName

string | null

Display name to record as the actor. An API key is not a person, so when it is omitted or blank the actor is recorded as API.

响应

StatusCode

enum<integer>

可用选项:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object

The identifier of the updated project.

Show child attributes

DataContext

object | null

示例:

null

Notifications

object[]

Show child attributes

⌘I

Updates a project. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/projects/{projectId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Title": "<string>",
  "Description": "<string>",
  "ClientId": 123,
  "LocationId": 123,
  "SharedWithContactIds": [
    123
  ],
  "TypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "TagIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "LeadAssigneeId": 123,
  "WatcherIds": [
    123
  ],
  "GroupIds": [
    123
  ],
  "TargetDate": "2023-11-07T05:31:56Z",
  "ClearTargetDate": true,
  "StatusId": 123,
  "StatusReason": "<string>",
  "ClosedOn": "2023-11-07T05:31:56Z",
  "UpdatedByName": "<string>"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/projects/{projectId}"

payload = {
    "Title": "<string>",
    "Description": "<string>",
    "ClientId": 123,
    "LocationId": 123,
    "SharedWithContactIds": [123],
    "TypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "TagIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "LeadAssigneeId": 123,
    "WatcherIds": [123],
    "GroupIds": [123],
    "TargetDate": "2023-11-07T05:31:56Z",
    "ClearTargetDate": True,
    "StatusId": 123,
    "StatusReason": "<string>",
    "ClosedOn": "2023-11-07T05:31:56Z",
    "UpdatedByName": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Title: '<string>',
    Description: '<string>',
    ClientId: 123,
    LocationId: 123,
    SharedWithContactIds: [123],
    TypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    TagIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    LeadAssigneeId: 123,
    WatcherIds: [123],
    GroupIds: [123],
    TargetDate: '2023-11-07T05:31:56Z',
    ClearTargetDate: true,
    StatusId: 123,
    StatusReason: '<string>',
    ClosedOn: '2023-11-07T05:31:56Z',
    UpdatedByName: '<string>'
  })
};

fetch('https://api.usw.gorelo.io/v1/projects/{projectId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/projects/{projectId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'Title' => '<string>',
    'Description' => '<string>',
    'ClientId' => 123,
    'LocationId' => 123,
    'SharedWithContactIds' => [
        123
    ],
    'TypeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'TagIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'LeadAssigneeId' => 123,
    'WatcherIds' => [
        123
    ],
    'GroupIds' => [
        123
    ],
    'TargetDate' => '2023-11-07T05:31:56Z',
    'ClearTargetDate' => true,
    'StatusId' => 123,
    'StatusReason' => '<string>',
    'ClosedOn' => '2023-11-07T05:31:56Z',
    'UpdatedByName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/projects/{projectId}"

	payload := strings.NewReader("{\n  \"Title\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"LeadAssigneeId\": 123,\n  \"WatcherIds\": [\n    123\n  ],\n  \"GroupIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"ClearTargetDate\": true,\n  \"StatusId\": 123,\n  \"StatusReason\": \"<string>\",\n  \"ClosedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedByName\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.usw.gorelo.io/v1/projects/{projectId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Title\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"LeadAssigneeId\": 123,\n  \"WatcherIds\": [\n    123\n  ],\n  \"GroupIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"ClearTargetDate\": true,\n  \"StatusId\": 123,\n  \"StatusReason\": \"<string>\",\n  \"ClosedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedByName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/projects/{projectId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Title\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"LeadAssigneeId\": 123,\n  \"WatcherIds\": [\n    123\n  ],\n  \"GroupIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"ClearTargetDate\": true,\n  \"StatusId\": 123,\n  \"StatusReason\": \"<string>\",\n  \"ClosedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedByName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}