enrollmentStatus

Query

Get the status of an enrollment by enrollment ID

Query Signature

query {
  enrollmentStatus(enrollmentId: String!): EnrollmentStatusResponse!
}

Example Request

GraphQL

query EnrollmentStatus($enrollmentId: String!) {
  enrollmentStatus(enrollmentId: $enrollmentId) {
    # Add fields you want to retrieve
  }
}

Example Variables:

{
  "enrollmentId": "enroll-abc123xyz"
}

Apollo Studio

Open in Apollo Studio Explorer →

Click the link above to open this query in Apollo Studio Explorer with the query pre-filled. You’ll need to authenticate with your sandbox credentials.

Example Response

{
  "data": {
    "enrollmentStatus": {
      "data": {
        "qaCall": "COMPLETED",
        "createContact": "COMPLETED",
        "createNotes": "COMPLETED",
        "createDebts": "COMPLETED",
        "createBudget": "COMPLETED",
        "createEnrollmentPlan": "COMPLETED",
        "createBankAccount": "COMPLETED",
        "createDocuments": "COMPLETED"
      },
      "errors": null
    }
  }
}

Arguments

Argument	Type	Description
enrollmentId	String!	TBD

Response Type

Returns: EnrollmentStatusResponse!

EnrollmentStatusResponse

Response wrapper for enrollmentStatus query

Field	Type	Description
data	EnrollmentStatusData	Enrollment status data on success
errors	[EnrollmentError]	List of errors if enrollment not found or processing failed

EnrollmentStatusData

Enrollment status data containing the current state

Field	Type	Description
contactId	String	Contact ID, populated once contact creation completes successfully
qaCall	EnrollmentStatus!	QA call status - indicates the current state of the enrollment processing
createContact	EnrollmentStatus!	Contact creation status
createEnrollmentPlan	EnrollmentStatus!	Enrollment plan creation status
createNotes	EnrollmentStatus!	Notes creation status
createDebts	EnrollmentStatus!	Debts creation status
createBudget	EnrollmentStatus!	Budget creation status
createBankAccount	EnrollmentStatus!	Bank account creation status
createDocuments	EnrollmentStatus!	Documents creation status

EnrollmentError

Error type for enrollment operations

Field	Type	Description
message	String	Error message describing the issue

Additional Enums

EnrollmentStatus

Current status of the enrollment

Value	Description
PENDING	The operation has not started yet
IN_PROGRESS	The operation is currently being processed
COMPLETED	The operation finished successfully
FAILED	The operation encountered an error and did not complete
SKIPPED	The operation was skipped (e.g., no data to process)

Error Types

The response may include the following error types:

EnrollmentError

Error type for enrollment operations

Field	Type	Description
message	String	Error message describing the issue

Error Details

Input Validation Errors

Error Code	Description	Resolution
INVALID_ENROLLMENT_ID	The enrollmentId must be a valid UUID format	Ensure enrollmentId is the UUID returned from createEnrollment

Query Errors

Error Code	Description	Resolution
Enrollment with id {id} not found	No enrollment exists with the specified ID	Verify the enrollmentId was returned from a successful createEnrollment call

Related

• Back to Lead Enrollment