Sites

Create Site

POST

Creates a new site with the provided details.

Returns the site.


For more information see the Site Model.

Request

This endpoint expects an object.
id
integerOptional
Unique identifier for the site, managed by Impilo.
name
stringOptional
The name of the site.
active
booleanOptional
True if the site is active, false otherwise.
address
objectOptional
The shipping address for the site.

Response

This endpoint returns an object
id
integerOptional
Unique identifier for the site, managed by Impilo.
name
stringOptional
The name of the site.
active
booleanOptional
True if the site is active, false otherwise.
address
objectOptional
The shipping address for the site.
POST
1curl -X POST https://app.impiloplatform.com/api/v3/site \
2 -H "Impilo-API-Key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "id": 561,
6 "name": "Building B",
7 "active": true,
8 "address": {
9 "lineOne": "1234 Market Street",
10 "lineTwo": "Suite 110",
11 "city": "Philadelphia",
12 "state": "PA",
13 "zipCode": "19137",
14 "country": "USA"
15 }
16}'
200Successful
1{
2 "id": 561,
3 "name": "Building B",
4 "active": true,
5 "address": {
6 "lineOne": "1234 Market Street",
7 "lineTwo": "Suite 110",
8 "lineThree": "lineThree",
9 "city": "Philadelphia",
10 "state": "PA",
11 "zipCode": "19137",
12 "country": "USA",
13 "note": "note"
14 }
15}