Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Assign a user to a credentialing workflow

Creates a new user assignment record for the credentialing workflow identified by id. An assignment associates a staff user with the workflow for tracking and accountability purposes. Returns the created AssignmentHistoryResponse object with the server-assigned assignment id and timestamp on 201.

post/credentialing-workflows/{id}/assignments

Path parameters

idstring required

ID of the credentialing workflow

Headers

tenant-idstring required

Tenant ID

Request body

assignedTostring

User ID being assigned to

reasonstring

Optional reason for the assignment

Example request

{
  "assignedTo": "user_123456",
  "reason": "Load balancing"
}

Response

Successfully created the assignment

workflowIdstring

Unique identifier for the credentialing workflow

tenantIdstring

ID of the tenant

tenantPractitionerIdstring

ID of the tenant practitioner

Example response

{
  "workflowId": "1234",
  "tenantId": "tenant_123456",
  "tenantPractitionerId": "tp_123456",
  "assignments": [
    {
      "assignedFrom": "user_123456",
      "assignedTo": "user_789012",
      "assignedBy": "user_345678",
      "assignedOn": "2021-01-01T00:00:00Z",
      "reason": "Load balancing"
    }
  ]
}