Skip to main content
POST
/
v3
/
organisations
Add Organisation
curl --request POST \
  --url http://localhost/api/v3/organisations \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>",
  "type": "company",
  "description": "<string>",
  "short_description": "<string>",
  "icon": "<string>",
  "image_url": "<string>",
  "notes": "<string>",
  "status": "<string>",
  "is_tenant": true,
  "is_active": true,
  "phone": "<string>",
  "email": "jsmith@example.com",
  "secondary_phone": "<string>",
  "domain": "<string>",
  "authorised_domains": "<string>",
  "meta": [
    "<string>"
  ],
  "address": {
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "address_line_3": "<string>",
    "company": "<string>",
    "is_default": true,
    "latitude": 123,
    "longitude": 123,
    "city": "<string>",
    "postcode": "<string>",
    "state": "<string>",
    "country": "<string>",
    "notes": "<string>",
    "iso": "<string>",
    "iso_state": "<string>"
  },
  "locations": [
    123
  ],
  "custom_fields": [
    {
      "namespace": "<string>",
      "handle": "<string>",
      "type": "string",
      "value": "<string>"
    }
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "description": "<string>",
    "short_description": "<string>",
    "icon": "<string>",
    "image_url": "<string>",
    "notes": "<string>",
    "type": "<string>",
    "status": "<string>",
    "is_tenant": 123,
    "is_active": 123,
    "phone": "<string>",
    "email": "<string>",
    "secondary_phone": "<string>",
    "domain": "<string>",
    "authorised_domains": [
      "<unknown>"
    ],
    "meta": [
      "<unknown>"
    ],
    "locations": [
      {
        "id": 123,
        "type": "<string>",
        "name": "<string>",
        "handle": "<string>",
        "description": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "timezone": "<string>",
        "external_id": "<string>",
        "external_code": "<string>",
        "is_published": true,
        "is_permanently_closed": true,
        "address": {
          "id": 123,
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "address_line_3": "<string>",
          "company": "<string>",
          "latitude": 123,
          "longitude": 123,
          "city": "<string>",
          "postcode": "<string>",
          "state": "<string>",
          "country": "<string>",
          "notes": "<string>",
          "external_id": "<string>",
          "is_default": true,
          "created_at": "<string>",
          "updated_at": "<string>",
          "meta": [
            "<unknown>"
          ],
          "name": "<string>",
          "type": "<string>",
          "phone": "<string>",
          "iso": "<string>",
          "iso_state": "<string>",
          "profile_id": "<string>",
          "custom_fields": {}
        },
        "normal_hours": [
          [
            "<unknown>"
          ]
        ],
        "special_hours": [
          [
            "<unknown>"
          ]
        ],
        "tags": [
          "<string>"
        ],
        "custom_fields": {},
        "icon": "<string>",
        "country_iso_3": "<string>",
        "image_url": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "departments": [
          {
            "id": 123,
            "name": "<string>",
            "handle": "<string>",
            "external_id": "<string>",
            "external_code": "<string>",
            "description": "<string>",
            "short_description": "<string>",
            "url": "<string>",
            "image_url": "<string>",
            "internal_note": "<string>",
            "meta": [
              "<unknown>"
            ],
            "brand_id": 123,
            "location_id": 123,
            "brand": {
              "name": "<string>",
              "handle": "<string>"
            },
            "created_at": "<string>",
            "updated_at": "<string>"
          }
        ]
      }
    ],
    "address": {
      "id": 123,
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_line_3": "<string>",
      "company": "<string>",
      "latitude": 123,
      "longitude": 123,
      "city": "<string>",
      "postcode": "<string>",
      "state": "<string>",
      "country": "<string>",
      "notes": "<string>",
      "external_id": "<string>",
      "is_default": true,
      "created_at": "<string>",
      "updated_at": "<string>",
      "meta": [
        "<unknown>"
      ],
      "name": "<string>",
      "type": "<string>",
      "phone": "<string>",
      "iso": "<string>",
      "iso_state": "<string>",
      "profile_id": "<string>",
      "custom_fields": {}
    },
    "custom_fields": {},
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
name
string
required
handle
string
required
type
enum<string>
required
Available options:
company,
stockist,
brand,
organisation,
group,
school,
club,
other
description
string | null
short_description
string | null
icon
string<uri> | null
image_url
string<uri> | null
notes
string | null
status
string | null
is_tenant
boolean | null
is_active
boolean | null
phone
string | null
email
string<email> | null
secondary_phone
string | null
domain
string | null
authorised_domains
string | null
meta
string[] | null
address
object
locations
integer[] | null
custom_fields
object[]

Response

Organisation

data
Organisation · object
required