Sign in
latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

companies

Create a new Company

post/v1/companies

Request body

namestring required
identifierstring

An external identifier that can be used by integrated systems

require_mfaboolean required

Whether new users will have multi-factor authentication enabled

Example request

{
  "name": "Jones Group, Inc.",
  "identifier": "CA0001-A"
}

Response

The newly created Company

Example response

{
  "data": {
    "uuid": "3699af0f-9b92-410d-945c-bb0bf39da904",
    "name": "Jones Group, Inc.",
    "identifier": "CA0001-A",
    "_links": {
      "fieldguide": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}