Create Organization

POST 
https://sight.inspectorio.com/api/v1/organizations

Create Organization

Request

application/json

Body

addressstringrequired
Organization address line 1
Possible values: non-empty
Example: 5 Madison Avenue
address2string
Organization address line 2
Example: Suite 101
billing_emailstringnullable
Billing email
Example: email@test.com
citystringnullable
City where the organization locates
Example: New York
contacts object[]required
Organization contact information
Possible values: >= 1
Array [
emailstring
Email of the organization contact
Example: john@acme.com
firstNamestringrequired
First name of the organization contact
Possible values: non-empty
Example: John
lastNamestringnullable
Last name of the organization contact
Example: Doe
phonestringnullable
Phone number of the organization contact
Example: 1505123123
workPhonestring
Work phone number of the organization contact
Example: 1505456456
]
countrystringrequired
ISO Alpha-2 country code
Example: US
idstringrequired

Possible values: non-empty

linkedIdstringnullable
Default value: null
Example: 123123
location objectnullable
Organization location
latitudenumberrequired
Latitude of the organization location
Example: 38.8951
longitudenumberrequired
Longitude of the organization location
Example: -77.0364
namestringrequired
Name of the organization
Possible values: non-empty
Example: Acme Corp
officeIdstringnullable
Office ID
Example: office_123
phonestringrequired
Organization phone number
Possible values: non-empty
Example: 1505111222
postalstringnullable
Organization postal code
Example: A1B2C3
provincestringnullable
Province where the organization locates
Example: New York
typestringrequired
Support F(Factory) S(Supplier) B(Brand) R(Retailer) V(Vendor)
Possible values: non-empty
Example: S
descriptionstringnullable
description of the local organization
Example: This is a description

Responses

201

Created

application/json

Schema

Schema

data object
addressstringrequired
Organization address line 1
Possible values: non-empty
Example: 5 Madison Avenue
address2string
Organization address line 2
Example: Suite 101
billing_emailstringnullable
Billing email
Example: email@test.com
citystringnullable
City where the organization locates
Example: New York
contacts object[]required
Organization contact information
Possible values: >= 1
Array [
emailstring
Email of the organization contact
Example: john@acme.com
firstNamestringrequired
First name of the organization contact
Possible values: non-empty
Example: John
lastNamestringnullable
Last name of the organization contact
Example: Doe
phonestringnullable
Phone number of the organization contact
Example: 1505123123
workPhonestring
Work phone number of the organization contact
Example: 1505456456
]
countrystringrequired
ISO Alpha-2 country code
Example: US
createdAtstring
Creation date and time of the organization in the system
Example: 2021-06-02 12:34:02.861000+00:00
idstringrequired
Possible values: non-empty
linkedTostring
Global organization that links to this local organization
Example: 3111222
location objectnullable
Organization location
latitudenumberrequired
Latitude of the organization location
Example: 38.8951
longitudenumberrequired
Longitude of the organization location
Example: -77.0364
namestringrequired
Name of the organization
Possible values: non-empty
Example: Acme Corp
officeIdstringnullable
Office ID
Example: office_123
phonestringrequired
Organization phone number
Possible values: non-empty
Example: 1505111222
postalstringnullable
Organization postal code
Example: A1B2C3
provincestringnullable
Province where the organization locates
Example: New York
typestringrequired
Support F(Factory) S(Supplier) B(Brand) R(Retailer) V(Vendor)
Possible values: non-empty
Example: S
updatedAtstring
Last updated date and time of the organization in the system
Example: 2021-06-02 12:34:02.861000+00:00
descriptionstringnullable
description of the local organization
Example: This is a description

Example (auto)

{
  "data": {
    "address": "5 Madison Avenue",
    "address2": "Suite 101",
    "billing_email": "email@test.com",
    "city": "New York",
    "contacts": [
      {
        "email": "john@acme.com",
        "firstName": "John",
        "lastName": "Doe",
        "phone": "1505123123",
        "workPhone": "1505456456"
      }
    ],
    "country": "US",
    "createdAt": "2021-06-02 12:34:02.861000+00:00",
    "id": "string",
    "linkedTo": "3111222",
    "location": {
      "latitude": 38.8951,
      "longitude": -77.0364
    },
    "name": "Acme Corp",
    "officeId": "office_123",
    "phone": "1505111222",
    "postal": "A1B2C3",
    "province": "New York",
    "type": "S",
    "updatedAt": "2021-06-02 12:34:02.861000+00:00",
    "description": "This is a description"
  }
}

400

Bad request

application/json

Schema

Schema

errorCodestring
Example: Generic
messagestring
Example: Bad Request

Example (auto)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCodestring
Example: Generic
messagestring
Example: Cannot retrieve session data because of expired token

Example (auto)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

422

Validation Error

application/json

Schema

Schema

errorCodestring
Example: Generic
errorsobject
Example: {"type":["Input type is not valid"]}
messagestring
Example: Validation error

Example (auto)

{
  "errorCode": "Generic",
  "errors": {
    "type": [
      "Input type is not valid"
    ]
  },
  "message": "Validation error"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCodestring
Example: Generic
messagestring
Example: Too many requests

Example (auto)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

500

Internal Error

application/json

Schema

Schema

errorCodestring
Example: Generic
errorsobject
Example: {"system":["Internal error detail message"]}
messagestring
Example: Internal server error

Example (auto)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Authorization: apiKey

name: apiKeytype: apiKeyin: header

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://sight.inspectorio.com/api/v1/organizations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'apiKey: <apiKey>' \
--data-raw '{
  "address": "5 Madison Avenue",
  "address2": "Suite 101",
  "billing_email": "email@test.com",
  "city": "New York",
  "contacts": [
    {
      "email": "john@acme.com",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "1505123123",
      "workPhone": "1505456456"
    }
  ],
  "country": "US",
  "id": "string",
  "linkedId": "123123",
  "location": {
    "latitude": 38.8951,
    "longitude": -77.0364
  },
  "name": "Acme Corp",
  "officeId": "office_123",
  "phone": "1505111222",
  "postal": "A1B2C3",
  "province": "New York",
  "type": "S",
  "description": "This is a description"
}'

Request Collapse all

Base URL

https://sight.inspectorio.com

Auth

ApiKeyAuth

Body

{
  "address": "5 Madison Avenue",
  "address2": "Suite 101",
  "billing_email": "email@test.com",
  "city": "New York",
  "contacts": [
    {
      "email": "john@acme.com",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "1505123123",
      "workPhone": "1505456456"
    }
  ],
  "country": "US",
  "id": "string",
  "linkedId": "123123",
  "location": {
    "latitude": 38.8951,
    "longitude": -77.0364
  },
  "name": "Acme Corp",
  "officeId": "office_123",
  "phone": "1505111222",
  "postal": "A1B2C3",
  "province": "New York",
  "type": "S",
  "description": "This is a description"
}

ResponseClear

Click the Send API Request button above and see the response here!