Skip to content

Create Sites

Creates a new Site within a specified Account. Any fields not specified will be created as null.

Verb PUT
Endpoint {base-url}/sites
Max Page Size 50

Request Body

{
  "body": [
    {
      "AccountId": 11,
      "OrgId": 3,
      "Name": "Bob's Grain Mill",
      "contact": {
            "firstName": "testFirst testLast",
            "lastName": null,
            "telephoneNumber": "123-456-7890",
            "emailAddress": "test@test.com"
      },
      "CommissionPercentage": null,
      "IsActive": true,
      "TimeZone": "Pacific Standard Time",
      "IsEnabled": false,
      "MaxChargePrice": 5,
      "BillingAddress": "Bob's Grain Mill, 123 Main Street, Seattle, WA 11111",
      "ShippingAddress": "Bob's Grain Mill, 123 Main Street, Seattle, WA 11111",
      "MaximumMeterSalesJumpAllowed": 500,
      "CommissionTerms": "Net10",
      "ExternalAccountTerminalId": null,
      "chargeKeyId": 1
    }
  ]
}

Returns

On Success

The ids of the created sites.

Response Body

[
  1673
]

On Error

HTTP Code Error Code Definition
400 NAME_UNIQUENESS Site names must be unique at the account level when updating or creating. See the error message for what names caused the issue.
422 SITE_VALIDATION One or more of your sites failed validation. See the error message for more detailed information.