FIfieldguide
companies

Update the specified Company

Changed on
patch/v1/companies/{uuid}

Request

  • Base URL
    https://api.fieldguide.io
  • URL
    https://api.fieldguide.io/v1/companies/{uuid}
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required

The UUID of the Company to update

Request body

namestring
identifierstring nullable

An external identifier that can be used by integrated systems

require_mfaboolean

Whether new users will have multi-factor authentication enabled

Example request

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

Response

The updated Company

Example response

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

Changes