Assets

Updates an agent (managed device) asset. Send only the fields you want to change.

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

Description, ContactId, WarrantyStartDate and WarrantyEndDate are cleared by sending them as null; a cleared warranty date is filled in again by Gorelo’s warranty lookup, and a date set here is kept rather than overwritten by it. HardwareTypeId cannot be cleared; null leaves it unchanged.

ContactId must be an active contact of the agent’s client, so an agent awaiting adoption (no client) cannot be given one. The primary contact is also listed under the agent’s related items: assigning a contact adds it there, and replacing or clearing it removes the previous one. Each change is recorded on the agent’s timeline, as it is when the agent is edited in the app.

PATCH

assets

agents

{agentAssetId}

Updates an agent (managed device) asset. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/assets/agents/{agentAssetId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Description": "Reception PC, front desk",
  "HardwareTypeId": 118,
  "ContactId": 7962,
  "WarrantyStartDate": "2024-03-31",
  "WarrantyEndDate": "2027-03-31"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/assets/agents/{agentAssetId}"

payload = {
    "Description": "Reception PC, front desk",
    "HardwareTypeId": 118,
    "ContactId": 7962,
    "WarrantyStartDate": "2024-03-31",
    "WarrantyEndDate": "2027-03-31"
}
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({
    Description: 'Reception PC, front desk',
    HardwareTypeId: 118,
    ContactId: 7962,
    WarrantyStartDate: '2024-03-31',
    WarrantyEndDate: '2027-03-31'
  })
};

fetch('https://api.usw.gorelo.io/v1/assets/agents/{agentAssetId}', 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/assets/agents/{agentAssetId}",
  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([
    'Description' => 'Reception PC, front desk',
    'HardwareTypeId' => 118,
    'ContactId' => 7962,
    'WarrantyStartDate' => '2024-03-31',
    'WarrantyEndDate' => '2027-03-31'
  ]),
  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/assets/agents/{agentAssetId}"

	payload := strings.NewReader("{\n  \"Description\": \"Reception PC, front desk\",\n  \"HardwareTypeId\": 118,\n  \"ContactId\": 7962,\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"WarrantyEndDate\": \"2027-03-31\"\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/assets/agents/{agentAssetId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Description\": \"Reception PC, front desk\",\n  \"HardwareTypeId\": 118,\n  \"ContactId\": 7962,\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"WarrantyEndDate\": \"2027-03-31\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/assets/agents/{agentAssetId}")

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  \"Description\": \"Reception PC, front desk\",\n  \"HardwareTypeId\": 118,\n  \"ContactId\": 7962,\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"WarrantyEndDate\": \"2027-03-31\"\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>"
    }
  ]
}

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

agentAssetId

string<uuid>

required

Agent asset to update.

Body

Fields to change.

Request body for updating an agent asset. Every field is optional - send only what should change. An omitted field keeps the value the agent already holds.

Description

string | null

Free-text description, max 2000 characters. Send null to clear it.

Example:

"Reception PC, front desk"

HardwareTypeId

integer<int64> | null

Identifier of the agent's asset type, one of the active types GET /v1/assets/types lists. Sets the agent's Type. Null leaves it unchanged.

Example:

118

ContactId

integer<int64> | null

Identifier of the contact the agent is assigned to; must be an active contact of the agent's client, so an agent with no client cannot take one. Send null to unassign it.

Example:

7962

WarrantyStartDate

string<date> | null

Date the warranty starts, a calendar date in the form yyyy-MM-dd. A value with a time or a time zone is rejected. Send null to clear it, which lets Gorelo's warranty lookup fill it in again.

Example:

"2024-03-31"

WarrantyEndDate

string<date> | null

Date the warranty ends, a calendar date in the form yyyy-MM-dd. A value with a time or a time zone is rejected. Send null to clear it, which lets Gorelo's warranty lookup fill it in again.

Example:

"2027-03-31"

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

The identifier of the updated agent asset.

Show child attributes

DataContext

object | null

Example:

null

Notifications

object[]

Show child attributes

⌘I

Updates an agent (managed device) asset. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/assets/agents/{agentAssetId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Description": "Reception PC, front desk",
  "HardwareTypeId": 118,
  "ContactId": 7962,
  "WarrantyStartDate": "2024-03-31",
  "WarrantyEndDate": "2027-03-31"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/assets/agents/{agentAssetId}"

payload = {
    "Description": "Reception PC, front desk",
    "HardwareTypeId": 118,
    "ContactId": 7962,
    "WarrantyStartDate": "2024-03-31",
    "WarrantyEndDate": "2027-03-31"
}
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({
    Description: 'Reception PC, front desk',
    HardwareTypeId: 118,
    ContactId: 7962,
    WarrantyStartDate: '2024-03-31',
    WarrantyEndDate: '2027-03-31'
  })
};

fetch('https://api.usw.gorelo.io/v1/assets/agents/{agentAssetId}', 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/assets/agents/{agentAssetId}",
  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([
    'Description' => 'Reception PC, front desk',
    'HardwareTypeId' => 118,
    'ContactId' => 7962,
    'WarrantyStartDate' => '2024-03-31',
    'WarrantyEndDate' => '2027-03-31'
  ]),
  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/assets/agents/{agentAssetId}"

	payload := strings.NewReader("{\n  \"Description\": \"Reception PC, front desk\",\n  \"HardwareTypeId\": 118,\n  \"ContactId\": 7962,\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"WarrantyEndDate\": \"2027-03-31\"\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/assets/agents/{agentAssetId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Description\": \"Reception PC, front desk\",\n  \"HardwareTypeId\": 118,\n  \"ContactId\": 7962,\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"WarrantyEndDate\": \"2027-03-31\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/assets/agents/{agentAssetId}")

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  \"Description\": \"Reception PC, front desk\",\n  \"HardwareTypeId\": 118,\n  \"ContactId\": 7962,\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"WarrantyEndDate\": \"2027-03-31\"\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>"
    }
  ]
}