Propelus
Monitoring

Update a Professional's Credential

Update credentials associated with a professional in the Propelus system.

Partial update of a professional's credential, identified by professionalId and credentialId, following JSON Merge Patch (RFC 7396) semantics. Fields omitted from the request body are left unchanged. Fields set to null are cleared where the schema allows it. Use this endpoint to update any subset of a credential's attributes.

PATCH
/v2/professionals/{professionalId}/credentials/{credentialId}

Authorization

apiKey clientId
x-api-key<token>

In: header

x-client-id<token>

In: header

Path Parameters

professionalId*string

Unique identifier for the professional.

credentialId*string

Unique identifier for the professional's credential.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v2/professionals/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a/credentials/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a" \  -H "Content-Type: application/json" \  -d '{    "number": "string",    "code": "RN",    "state": "CA"  }'
{
  "status": 201,
  "code": "updated_non_monitored",
  "detail": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 429,
  "detail": "string",
  "code": "f5d62b05-370e-48be-a755-8675ca146431"
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 500,
  "detail": "string",
  "code": "unexpected_error"
}

Get a Professional's Credential by ID GET

Get a credential by utilizing both `professionalId` and `credentialId`. The response body will include the credential details as they are listed in Propelus.

Delete Credential by ID DELETE

Delete a professional credential by the Propelus generated `professionalId` and `credentialId` as unique identifiers. Warning: This operation is irreversible. If you would like to perform a non-permanent action, simply remove the [monitoring product](/monitoring/DeleteMonitoringById) instead of deleting the credential.