sam|nord Developers
samnord.com
Sites

POST /sites

Create a site. Requires sites.create permission.

Query parameters

Name Type Required Description
fields[] string[] no Select which fields to include in the response. When omitted, all fields are returned. When provided, only the specified fields are included. (e.g., ?fields[]=id&fields[]=name) One of: country, createdAt, description, id, latitude, line1, line2, longitude, name, postalAddress, postalCode, updatedAt.
with[] string[] no Include related resources in the response. Pass multiple values as separate query parameters (e.g., ?with[]=createdBy&with[]=updatedBy). One of: createdBy, updatedBy.

Request body

Required.

application/json

  • country string · required
  • description string
  • line1 string · required
  • line2 string
  • name string · required
  • postalAddress string · required
  • postalCode string · required
{
    "country": "SWE",
    "description": "Main office location",
    "line1": "Drottninggatan 95",
    "line2": "4th Floor",
    "name": "Stockholm Office",
    "postalAddress": "Stockholm",
    "postalCode": "111 60"
}

Responses

Status Description
201 A json object describing the newly created site
400 The request was rejected
403 The requesting user lacks appropriate permissions
422 Validation errors

Response 201 body

  • data object · required — When fields[] is not provided, all properties are returned. When fields[] is provided, only the requested properties are included.
  • meta object · required
{
    "data": {
        "id": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
        "country": "SWE",
        "createdAt": "2024-06-30T19:00:00Z",
        "createdBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        },
        "description": "Main office location",
        "latitude": 59.3293,
        "line1": "Drottninggatan 95",
        "line2": "4th Floor",
        "longitude": 18.0686,
        "name": "Stockholm Office",
        "postalAddress": "Stockholm",
        "postalCode": "111 60",
        "updatedAt": "2024-06-30T19:00:00Z",
        "updatedBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        }
    },
    "meta": {
        "requestId": "019a3a60-6328-7075-8a41-76ff545ca5d3",
        "userId": "019a3a60-929c-7820-9b35-bf79a8bf83a6",
        "organizationId": "019a3a60-8175-7a68-88da-ecb4a7040b86"
    }
}