Updates an existing client. Only supplied (non-null) fields are changed.

PATCH

clients

{clientId}

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/clients/{clientId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Name": "<string>",
  "StatusId": 123,
  "BillingName": "<string>",
  "AlternateName": "<string>",
  "CustomProperties": [
    {
      "Id": 123,
      "Value": "<string>"
    }
  ],
  "GroupIds": [
    123
  ]
}
'

import requests

url = "https://api.usw.gorelo.io/v1/clients/{clientId}"

payload = {
    "Name": "<string>",
    "StatusId": 123,
    "BillingName": "<string>",
    "AlternateName": "<string>",
    "CustomProperties": [
        {
            "Id": 123,
            "Value": "<string>"
        }
    ],
    "GroupIds": [123]
}
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({
    Name: '<string>',
    StatusId: 123,
    BillingName: '<string>',
    AlternateName: '<string>',
    CustomProperties: [{Id: 123, Value: '<string>'}],
    GroupIds: [123]
  })
};

fetch('https://api.usw.gorelo.io/v1/clients/{clientId}', 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/clients/{clientId}",
  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([
    'Name' => '<string>',
    'StatusId' => 123,
    'BillingName' => '<string>',
    'AlternateName' => '<string>',
    'CustomProperties' => [
        [
                'Id' => 123,
                'Value' => '<string>'
        ]
    ],
    'GroupIds' => [
        123
    ]
  ]),
  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/clients/{clientId}"

	payload := strings.NewReader("{\n  \"Name\": \"<string>\",\n  \"StatusId\": 123,\n  \"BillingName\": \"<string>\",\n  \"AlternateName\": \"<string>\",\n  \"CustomProperties\": [\n    {\n      \"Id\": 123,\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"GroupIds\": [\n    123\n  ]\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/clients/{clientId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Name\": \"<string>\",\n  \"StatusId\": 123,\n  \"BillingName\": \"<string>\",\n  \"AlternateName\": \"<string>\",\n  \"CustomProperties\": [\n    {\n      \"Id\": 123,\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"GroupIds\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"Name\": \"<string>\",\n  \"StatusId\": 123,\n  \"BillingName\": \"<string>\",\n  \"AlternateName\": \"<string>\",\n  \"CustomProperties\": [\n    {\n      \"Id\": 123,\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"GroupIds\": [\n    123\n  ]\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "CustomProperties": [
      {
        "Id": 123,
        "Variable": "<string>",
        "Name": "<string>",
        "Type": {
          "Id": 1,
          "Name": "<string>"
        },
        "Value": "<string>",
        "IsSet": true,
        "IsHidden": true
      }
    ],
    "Id": 123,
    "Name": "<string>",
    "Status": {
      "Id": 1,
      "Name": "<string>"
    },
    "CreatedOn": "2023-11-07T05:31:56Z",
    "UpdatedOn": "2023-11-07T05:31:56Z",
    "BillingName": "<string>",
    "AlternateName": "<string>",
    "IsDefault": true,
    "Domains": [
      {
        "Id": 123,
        "Name": "<string>",
        "CreatedOn": "2023-11-07T05:31:56Z",
        "UpdatedOn": "2023-11-07T05:31:56Z",
        "ExpirationDate": "2023-12-25",
        "IsDateSetManually": true,
        "Status": {
          "Id": 1,
          "Name": "<string>"
        }
      }
    ],
    "GroupIds": [
      123
    ]
  },
  "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>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

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.

Path Parameters

clientId

integer<int64>

required

Client to update.

Body

Client fields to update.

Request body for updating a client. Only the supplied (non-null) fields are changed; Id, bound from the route, identifies the client to update.

Name

string | null

New client display name. Leave null to keep the current value. Maximum 150 characters.

StatusId

integer<int32> | null

New status id: 1 Active, 3 Credit hold, 4 Archived. Leave null to keep the current value. Any other value is a 400; to delete a client use DELETE /v1/clients/{clientId}.

BillingName

string | null

New billing name. Leave null or empty to keep the current value. Maximum 150 characters.

AlternateName

string | null

New alternate / trading name. Leave null to keep the current value; send an empty string to clear it. Maximum 500 characters.

CustomProperties

object[] | null

Custom field values to upsert. Identified by Id (the custom field id) only - an entry present updates that field's value, one absent from the array is left untouched, and omitting CustomProperties entirely leaves all custom properties untouched. A null``Value clears the saved value so the field falls back to its default; an empty string saves an empty value. On a required field, either is rejected when it would leave the field with no value. Each custom field id may appear once; a repeated id is a 400.

Show child attributes

GroupIds

integer<int64>[] | null

Group ids (from GET /v1/organization/groups) the client is subscribed to. Replaces the list; [] clears it; omit to leave unchanged. At most 100; every id must be an active group. Changing an existing client's groups changes which technicians can see it, so open Gorelo web sessions reload.

Response

StatusCode

enum<integer>

Available options:

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

A single client, as returned by GET /v1/clients/{clientId}, POST and PATCH: the list shape plus its custom properties, which the list deliberately leaves out. Timestamps are UTC.

Show child attributes

DataContext

object | null

Example:

null

Notifications

object[]

Show child attributes

⌘I

Updates an existing client. Only supplied (non-null) fields are changed.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/clients/{clientId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Name": "<string>",
  "StatusId": 123,
  "BillingName": "<string>",
  "AlternateName": "<string>",
  "CustomProperties": [
    {
      "Id": 123,
      "Value": "<string>"
    }
  ],
  "GroupIds": [
    123
  ]
}
'

import requests

url = "https://api.usw.gorelo.io/v1/clients/{clientId}"

payload = {
    "Name": "<string>",
    "StatusId": 123,
    "BillingName": "<string>",
    "AlternateName": "<string>",
    "CustomProperties": [
        {
            "Id": 123,
            "Value": "<string>"
        }
    ],
    "GroupIds": [123]
}
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({
    Name: '<string>',
    StatusId: 123,
    BillingName: '<string>',
    AlternateName: '<string>',
    CustomProperties: [{Id: 123, Value: '<string>'}],
    GroupIds: [123]
  })
};

fetch('https://api.usw.gorelo.io/v1/clients/{clientId}', 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/clients/{clientId}",
  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([
    'Name' => '<string>',
    'StatusId' => 123,
    'BillingName' => '<string>',
    'AlternateName' => '<string>',
    'CustomProperties' => [
        [
                'Id' => 123,
                'Value' => '<string>'
        ]
    ],
    'GroupIds' => [
        123
    ]
  ]),
  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/clients/{clientId}"

	payload := strings.NewReader("{\n  \"Name\": \"<string>\",\n  \"StatusId\": 123,\n  \"BillingName\": \"<string>\",\n  \"AlternateName\": \"<string>\",\n  \"CustomProperties\": [\n    {\n      \"Id\": 123,\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"GroupIds\": [\n    123\n  ]\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/clients/{clientId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Name\": \"<string>\",\n  \"StatusId\": 123,\n  \"BillingName\": \"<string>\",\n  \"AlternateName\": \"<string>\",\n  \"CustomProperties\": [\n    {\n      \"Id\": 123,\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"GroupIds\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"Name\": \"<string>\",\n  \"StatusId\": 123,\n  \"BillingName\": \"<string>\",\n  \"AlternateName\": \"<string>\",\n  \"CustomProperties\": [\n    {\n      \"Id\": 123,\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"GroupIds\": [\n    123\n  ]\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "CustomProperties": [
      {
        "Id": 123,
        "Variable": "<string>",
        "Name": "<string>",
        "Type": {
          "Id": 1,
          "Name": "<string>"
        },
        "Value": "<string>",
        "IsSet": true,
        "IsHidden": true
      }
    ],
    "Id": 123,
    "Name": "<string>",
    "Status": {
      "Id": 1,
      "Name": "<string>"
    },
    "CreatedOn": "2023-11-07T05:31:56Z",
    "UpdatedOn": "2023-11-07T05:31:56Z",
    "BillingName": "<string>",
    "AlternateName": "<string>",
    "IsDefault": true,
    "Domains": [
      {
        "Id": 123,
        "Name": "<string>",
        "CreatedOn": "2023-11-07T05:31:56Z",
        "UpdatedOn": "2023-11-07T05:31:56Z",
        "ExpirationDate": "2023-12-25",
        "IsDateSetManually": true,
        "Status": {
          "Id": 1,
          "Name": "<string>"
        }
      }
    ],
    "GroupIds": [
      123
    ]
  },
  "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>"
    }
  ]
}