Skip to main content
POST
/
site
Create site
curl --request POST \
  --url https://api.truecold.io/site \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "code": "<string>",
  "name": "<string>",
  "street": "<string>",
  "city": "<string>",
  "state": "<string>",
  "country": "<string>",
  "zip_code": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "code": "<string>",
  "name": "<string>",
  "city": "<string>",
  "country": "<string>",
  "state": "<string>",
  "street": "<string>",
  "soft_deleted": "2023-11-07T05:31:56Z",
  "soft_deleted_by": "<string>",
  "zip_code": "<string>",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Contact your administrator to get an API key.

Body

application/json

Site input data for creation/update

​
code
string

Site code

​
name
string

Site name

​
street
string

Street address

​
city
string

City name

​
state
string

State or province

​
country
string

Country name

​
zip_code
string

Postal code

Response

Successfully created site

Site entity (API response)

​
id
string<uuid>

Unique identifier

​
created_at
string<date-time>

Creation timestamp

​
updated_at
string<date-time>

Last update timestamp

​
code
string

code code

​
name
string

name name

​
city
string

City

​
country
string

Country

​
state
string

State

​
street
string

Street

​
soft_deleted
string<date-time>

Soft deletion timestamp

​
soft_deleted_by
string

User who soft deleted the record

​
zip_code
string

zip code

​
account_id
string<uuid>

Account ID