Skip to content

Create health professionals

POST/api/v1/workspaces/{workspaceId}/specialists

Operation ID: specialists.create · Access: PAT with write scope and authorized workspace where applicable · Effect: write.

Read the health professionals workflow before this operation.

Name In Required Type / allowed values
workspaceId path Yes string
idempotency-key header No string

Content type: application/json · Required: yes.

Schema: SpecialistInput. Browse schema fields.

Example: request

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
"documentType": "CC",
"documentNumber": "1000000001",
"firstName": "Profesional",
"lastName": "Ejemplo",
"registrationNumber": "REG-DEMO-001"
}
HTTP Content Schema
201 application/json Specialist
400 application/json ApiError
401 application/json ApiError
403 application/json ApiError
404 application/json ApiError
409 application/json ApiError
413 application/json ApiError
415 application/json ApiError
428 application/json ApiError
500 application/json ApiError

Use error.code, error.issues, and requestId for JSON errors. Error and recovery guide.

Set the connection variables from the quickstart. Set each path variable to an authorized identifier or an allowed parameter value from the table above.

Save your authorized JSON input as request.json. Use the request schema and examples above; replace synthetic data before use.

Terminal window
curl --fail-with-body --request POST \
"$RIPSCLOUD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/specialists" \
--header "Authorization: Bearer $RIPSCLOUD_TOKEN" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-binary @request.json