Create a professional in the Propelus system — the first step in enrolling them in monitoring.
The first step in enrolling a professional and/or their credentials in monitoring is to create the professional in the Propelus system. From there, you will complete steps to create the credential(s), then select the product you'd like to enroll for monitoring.
Create a professional with relevant demographic details. The only required fields are the professional's name and an associated ID.
Note: when enrolling a business, it is required to use the full name [fullName] option in the name object.
Endpoint:
HTTP Method: POST
Path: /v2/professionals
Server URL: https://api.propelus.com
Developer Docs: https://propelus.com/developer/monitoring/CreateProfessional
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 |
Request Body
Content type: application/json
| Field | Type | Required | Description / Constraints |
| externalId | string | Yes |
Foreign Key identifier from the customer's system to uniquely identify the professional. Length ≤ 100. |
| name | First & Last | Full Name | Yes |
Name of the professional or business. Use either first & last OR full [fullName] — not both. |
| alias | First & Last | Full Name | No |
Name of the professional or business. Use either first & last OR full — not both. |
| dob | string | No |
Date of Birth. Formats: YYYYMMDD | YYYYMM | YYYY. |
| ssn | SocialSecurityNumber | No |
Social Security Number. Match: ^[0-9]{9}$ |
| npi | NPI Number | No |
The National Provider Identifier (NPI) of the professional. Match: ^[0-9]{10}$ |
| address | Address with City & State | Address with ZIP | No |
Object containing an address. Requires line1 together with either city and state, or zip. |
No |
Email address. Format: email. Length ≤ 254. Match: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ | ||
| customProperties | object | null | No |
Additional properties to be stored with the professional or credential. Properties ≤ 10. |
Example Request — JSON
const body = JSON.stringify({})
fetch("https://api.propelus.com/v2/professionals", {
method: "POST",
headers: {
"Content-Type": "application/json",
"x-api-key": "<your-api-key>",
"x-client-id": "<your-client-id>"
},
body
})Example Request — cURL
curl -X POST "https://api.propelus.com/v2/professionals" \
-H "x-api-key: <your-api-key>" \
-H "x-client-id: <your-client-id>" \
-H "Content-Type: application/json" \
-d '{}'Responses
201 — Created
{
"status": 200,
"detail": "string",
"code": "created",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}Error Responses
Standardized error bodies. Validation-style errors (400, 401, 403, 4XX) include an errors array; each item contains detail, pointer, parameter, header, and code: https://propelus.com/developer/monitoring/CreateProfessional#request-body
400 — Bad Request
401 — Unauthorized
403 — Forbidden
404 — Not Found
4XX — Client Error
5XX — Server Error