Skip to main content
POST
Create CompanyShare for a Managed Company

Authorizations

Authorization
string
header
required

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

Headers

Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

company-id
string
required

Managing Company ID

managed-company-id
string
required

Managed Company ID

Body

application/json
receiver_company_id
string<uuid>
required
company_shareable_id
string<uuid>
required
company_shareable_type
enum<string>
required
Available options:
User,
Equipment,
Site
dispatchable
boolean

Whether the receiver Company can dispatch to the shared model.

dispatchable defaults to false for Equipment and true for User.

rate_override
boolean

Whether the receiver Company can override the Rate that will be used by the shared model when dispatched.

rate_override is always false for Equipment and defaults to false for User (can be edited to true)

expires_at
string<date-time>

ISO8601 timestamp with local timezone

ticket_match_id
string

Response

Created

data
CompanyShare-Read · object
required