Skip to content

Create a gas type

POST
/gas-types
curl --request POST \
--url https://example.com/gas-types \
--header 'Content-Type: application/json' \
--cookie bottle.session_token=<bottle.session_token> \
--data '{ "name": "example", "supplier": "example", "colour": "#D7263D" }'
Media typeapplication/json
object
name
required
string
>= 1 characters <= 80 characters
supplier
string | null
<= 80 characters
colour
string | null
/^#[0-9a-fA-F]{6}$/
Example
#D7263D

Created

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
supplier
required
string | null
colour
required
string | null
/^#[0-9a-fA-F]{6}$/
catalogueKey
required
string | null
archivedAt
required
string | null format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"name": "Flogas Propane",
"supplier": "Flogas",
"colour": "#D7263D"
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
"error": "not_found",
"message": "Customer not found"
}

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}