Skip to main content
PATCH
/
v1
/
companies
/
{company-id}
/
company_shares
/
{id}
Update a CompanyShare as a Company
curl --request PATCH \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/company_shares/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "ticket_match_id": "<string>",
  "dispatchable": true,
  "schedule_on": true,
  "rate_override": true,
  "default_equipment_id": "<string>",
  "default_additional_equipment_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "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

​
id
string<uuid>
required

CompanyShare ID

Body

application/json
​
external_id
string
​
ticket_match_id
string
​
dispatchable
boolean
​
schedule_on
boolean
​
rate_override
boolean
​
default_equipment_id
string | null
​
default_additional_equipment_ids
string<uuid>[]
​
expires_at
string<date-time> | null

ISO8601 timestamp with local timezone

Response

OK

​
data
CompanyShare-Read · object
required