Skip to main content
PUT
/
v3
/
orgs
/
{org_id}
/
workforce
/
competence
/
qualifications
/
{qualification_id}
Update an existing qualification
curl --request PUT \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/workforce/competence/qualifications/{qualification_id} \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "qualification_type": "<string>",
      "requires_assessment": true,
      "assessment_reference": "<string>",
      "description": "<string>",
      "renewal": {
        "required": false,
        "frequency": 2
      },
      "risk": {
        "carries": false,
        "unit": "<string>",
        "thresholds": {
          "high": 123,
          "medium": 123,
          "low": 123
        }
      }
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "qualification_type": "<string>",
      "requires_assessment": false,
      "assessment_reference": "",
      "description": "<string>",
      "renewal": {
        "required": false,
        "frequency": 2
      },
      "risk": {
        "carries": false,
        "unit": "<string>",
        "thresholds": {
          "high": 123,
          "medium": 123,
          "low": 123
        }
      }
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

qualification_id
string<uuid>
required

The unique identifier for the qualification.

Body

application/vnd.api+json

The qualification to update.

data
object
required

Response

Get a Qualification.

JSON API response object

data
object
required

A qualification

jsonapi
object
required