Skip to main content
POST
/
v1
/
companies
/
{company-id}
/
company_shares
Create a Company Share
curl --request POST \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/company_shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "receiver_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_shareable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dispatchable": true,
  "rate_override": true,
  "expires_at": "2023-11-07T05:31:56Z",
  "ticket_match_id": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "ticket_match_id": "<string>",
    "sender_company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tread_id": "ABC123",
      "legal_name": "<string>",
      "company_type": "hauler"
    },
    "dispatchable": true,
    "schedule_on": true,
    "rate_override": true,
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "parent_company_share_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_shareable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "receiver_company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tread_id": "ABC123",
      "legal_name": "<string>",
      "company_type": "hauler"
    },
    "company_shareable": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  }
}

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<uuid>
required

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