POST
Share a site with companies
Company space For: Manager, Stock keeper · Permission: asset_companies_{locations|vehicles}.create Conditions
  • company_ids is required, must hold at least one entry, with no duplicate, and every company must belong to the current organization.
  • A company that already has access to the asset cannot be added again; a company whose access was removed earlier can be given access again.
What else happens
  • Creates one sharing link per company. The companies then see the asset and can use it, for example as a transfer step location.
Part of Locations, vehicles and site sharing.

Authorizations

Authorization
string
header
required

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

Path Parameters

asset
string
required

Identifier of the location or vehicle (27-character KSUID).

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, asset_id, company_id, organization_id, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: company, company.organization.

Body

application/json
company_ids
string[]
required

Identifiers of the companies to share the asset with. Required, at least one, no duplicate, all in the current organization.

Minimum array length: 1

Response

Resource (only with response=resource).

data
AssetCompanyResource · object[]
required

Items of this page.