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.
Endpoint:
HTTP Method: PATCH
Path: /v2/professionals/{professionalId}/credentials/{credentialId}
Server URL: https://api.propelus.com
Developer Docs: https://propelus.com/developer/monitoring/PatchProfessionalCredential
Authentication
Two header-based authentication methods are required:
| Header | Type | In | Description |
| x-api-key | token | header | API key credential |
| x-client-id | token | header | Client identifier credential |
Path Parameters
| Parameter | Type | Required | Description |
| professionalId | string (UUID) | Yes |
Unique identifier for the professional. |
| credentialId | string (UUID) | Yes |
Unique identifier for the professional's credential. |
Request Body
Content type: application/json
| Field | Type | Required | Description / Constraints |
| number | string | Yes |
Credential number. Length ≤ 20. |
| code | string | Yes |
Propelus Code® associated with the credential type. Length ≤ 20. |
| state | string | Yes |
Two-letter state code where the credential is issued. Length: 2 ≤ length ≤ 4. |
| certState | string | No |
Optional two-letter state code. Only meaningful when state is CERT. Length ≤ 2. |
| customProperties | object | null | No |
Additional properties to be stored with the professional or credential. Properties ≤ 10. |
Example Request — JSON
const body = JSON.stringify({
"number": "string",
"code": "RN",
"state": "CA"
})
fetch("https://api.propelus.com/v2/professionals/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a/credentials/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"x-api-key": "<your-api-key>",
"x-client-id": "<your-client-id>"
},
body
})Example Request — cURL
curl -X PATCH "https://api.propelus.com/v2/professionals/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a/credentials/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a" \
-H "x-api-key: <your-api-key>" \
-H "x-client-id: <your-client-id>" \
-H "Content-Type: application/json" \
-d '{
"number": "string",
"code": "RN",
"state": "CA"
}'Responses
201 — Success
{
"status": 201,
"code": "updated_non_monitored",
"detail": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}Error Responses
Standardized error bodies. Validation-style errors include an errors array; each item contains detail, pointer, parameter, header, and code: https://propelus.com/developer/monitoring/PatchProfessionalCredential#request-body
400 — Bad Request
401 — Unauthorized
403 — Forbidden
404 — Not Found
4XX — Client Error
5XX — Server Error