Update for cargo by device

POST

/tracking/sharing_settings/cargo_by_device/v1

Updates the sharing settings for a cargo by device tracking dataset. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

cargo_idstringRequired

device_idstringRequired

publicbooleanRequired

task_group_idstringRequired

Response

Successful Response

_idstring

cargo_idstring

device_idstring

schema_versioninteger

task_group_idstring

last_changed_by_org_idstringOptional

Must be a string starting with org_

last_changed_by_user_idstringOptional

Must be a string starting with user_

last_changed_timestampdatetimeOptional

publicbooleanOptionalDefaults to false

Errors

422

Sharing Settings Cargo by Device Settings V1request Unprocessable Entity Error

1	import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3	async function main() {
4	const client = new ChrtClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
8	cargo_id: "cargo_987654321",
9	device_id: "device_123456789",
10	public: true,
11	task_group_id: "taskgroup_456def",
12	});
13	}
14	main();

1	{
2	"_id": "setting_abc123xyz",
3	"cargo_id": "cargo_987654321",
4	"device_id": "device_123456789",
5	"schema_version": 1,
6	"task_group_id": "taskgroup_456def",
7	"last_changed_by_org_id": "org_789xyz",
8	"last_changed_by_user_id": "user_456abc",
9	"last_changed_timestamp": "2024-01-15T09:30:00Z",
10	"public": true
11	}