Sign in
Organizations

Update organization

patch/api/organizations/{id}

Request

  • Base URL: https://ewihub.posechecker.com (the document declares no server; this is the origin it was published from)
  • URL: https://ewihub.posechecker.com/api/organizations/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring

Organization full name

abbreviationstring

Abbreviated name

notesstring

Optional notes

logostring

Logo URL or base64

coursesstring[]

Enabled courses

enableDepartmentsboolean

Enable department tracking

activeboolean

Whether organization is active

enableFollowUpStatusboolean

Enable follow-up status tracking for Self Assessment

followUpStatusesstring[]

Custom follow-up status options

Response

idstring required

Organization ID

namestring required

Organization name

abbreviationstring required

Abbreviated name

notesstring

Notes

logostring

Logo URL

apiKeystring required

API Key

coursesstring[] required

Enabled courses

enableDepartmentsboolean required

Enable departments

activeboolean required

Is active

departmentsstring[] required

Departments

enableFollowUpStatusboolean required

Enable follow-up status

followUpStatusesstring[] required

Follow-up status options

createdAtstring required

Creation timestamp

updatedAtstring required

Update timestamp

Example response

{
  "users": [
    {
      "id": "507f1f77bcf86cd799439011",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "username": "john_doe",
      "role": "orgUser",
      "organization": "507f1f77bcf86cd799439011",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.