Patch Resource

Request

Partially update an existing resource.

Security

oAuth2ClientCredentials

Path

resource_idstring, (uuid)(Resource Id)required

Bodyapplication/jsonrequired

One of:

is_archivedboolean or null(Is Archived)

Any of:

Set to false to reactivate a previously archived resource, or true to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged.

boolean

billing_entityBillingEntityReference (object) or null

Any of:

Billing entity associated with the resource, defaults to default billing entity if not provided

extrasArray of objects or null(Extras)

Any of:

Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras.

namestring or null(Name)

Any of:

Name of the resource

string

external_idstring(External Id)

External identifier of the resource. Omit to leave the current value unchanged; send "" to clear it. Despite the "" default shown, omitting the field does not clear it.

Default:""

localestring or null(Locale)

Any of:

Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.

string

codestring or null(Code)

Any of:

Code of the resource

string

notestring(Note)

Note about the resource. Omit to leave the current value unchanged; send "" to clear it. Despite the "" default shown, omitting the field does not clear it.

Default:""

custom_fieldsobject(Custom Fields)

User defined additional fields for this resource

subcontractorCompanyReference (object) or null

Any of:

Company linked to the resource

integrationsobject or null(Integrations)

Any of:

Related integrations for the resource. The key is the unique code of the integration in Qargo

driverDriverProperties (object) or null

Any of:

Driver specific properties

resource_groupResourceGroupReference (object) or null

Any of:

Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see resource_groups on the resource); this field manages only its primary allocation.

PATCH

/v1/resources/resource/{resource_id}

{
  "is_archived": true,
  "billing_entity": {
    "code": "string"
  },
  "extras": [
    { … }
  ],
  "name": "string",
  "external_id": "",
  "locale": "en",
  "code": "string",
  "note": "",
  "custom_fields": {},
  "subcontractor": {
    "row_id": "63f10953-3e9d-4dde-8a8d-8423a5ddfff4"
  },
  "integrations": {
    "addsecure1234": { … }
  },
  "driver": {
    "first_name": "string",
    "last_name": "string",
    "email_address": "string",
    "date_of_birth": "2025-04-10",
    "phone_number": "+32412345678",
    "start_stop_location": { … }
  },
  "resource_group": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Responses

Successful Response

Bodyapplication/json

Any of:

row_idstring, (uuid)(Row Id)required

Identifier of the reference

namestring(Name)required

Name of the resource

external_idstring or null(External Id)

Any of:

External identifier of the resource

string

localestring or null(Locale)

Any of:

Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.

string

codestring or null(Code)

Any of:

Code of the resource

string

notestring or null(Note)

Any of:

Note about the resource

string

custom_fieldsobject(Custom Fields)

User defined additional fields for this resource

subcontractorCompanyReference (object) or null

Any of:

Company linked to the resource

integrationsobject or null(Integrations)

Any of:

Related integrations for the resource. The key is the unique code of the integration in Qargo

billing_entityBillingEntity (object) or null

Any of:

Billing entity associated with the resource

extrasArray of objects(Extras)

Stop extras this resource is compatible with

is_activeboolean or null(Is Active)

Any of:

Is the resource active

boolean

is_external_resourceboolean or null(Is External Resource)

Any of:

Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. null indicates the value is not yet projected — treat as internal for backwards compatibility.

boolean

timestamp_updatedstring or null(Timestamp Updated)

Any of:

Timestamp of the last update of the resource

string (date-time)

resource_groupsArray of objects(Resource Groups)

Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded.

driverDriverProperties (object) or null

Any of:

Driver specific properties

Response

{
  "row_id": "63f10953-3e9d-4dde-8a8d-8423a5ddfff4",
  "name": "string",
  "external_id": "string",
  "locale": "en",
  "code": "string",
  "note": "string",
  "custom_fields": {},
  "subcontractor": {
    "row_id": "63f10953-3e9d-4dde-8a8d-8423a5ddfff4"
  },
  "integrations": {
    "addsecure1234": { … }
  },
  "billing_entity": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "legal_name": "Qargo BV",
    "vat_number": "NL123456789B01",
    "code": "QARGO",
    "company_registration_number": "12345678",
    "is_default": false
  },
  "extras": [
    { … }
  ],
  "is_active": true,
  "is_external_resource": true,
  "timestamp_updated": "2019-08-24T14:15:22Z",
  "resource_groups": [
    { … }
  ],
  "driver": {
    "first_name": "string",
    "last_name": "string",
    "email_address": "string",
    "date_of_birth": "2025-04-10",
    "phone_number": "+32412345678",
    "start_stop_location": { … }
  }
}

Patch Resource

Request

Path

Responses

Was this helpful?