Skip to main content
POST
/
v1
/
materials
Create a Material
curl --request POST \
  --url https://api.tread-horizon.com/v1/materials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "material_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "state": "active"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "system": true,
    "company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tread_id": "ABC123",
      "legal_name": "<string>",
      "company_type": "hauler"
    },
    "material_type": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "system": true
    },
    "state": "active",
    "external_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

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"

Body

application/json

The model for creating Materials

​
name
string
required

Name of the Material to be created.

​
material_type_id
string<uuid>

This is the id for MaterialType. If not provided, it will default to a MaterialType of Other

​
external_id
string | null
​
state
enum<string>
default:active

Material States

Available options:
active,
inactive

Response

Created

​
data
Material-Read · object
required