Application Examples

Apply to a Scholarship

Create an application record for a specific scholarship.

mutation Apply($scholarshipId: ID!) {
  scholarships {
    apply(scholarshipId: $scholarshipId)
  }
}

Variables:

{
  "scholarshipId": "12345"
}

Try in Playground →

Submit Application Requirement

Submit a required text/essay for an application.

mutation SubmitText($input: ApplicationRequirementInput!) {
  scholarships {
    submitApplicationRequirement(input: $input) {
      ... on ApplicationText {
        id
        text
      }
    }
  }
}

Variables:

{
  "input": {
    "scholarshipId": "12345",
    "requirementId": "req-789",
    "type": "TEXT",
    "text": "This is my scholarship essay..."
  }
}

Submit a Survey Requirement

mutation SubmitSurvey($input: ApplicationRequirementInput!) {
  scholarships {
    submitApplicationRequirement(input: $input) {
      ... on ApplicationSurvey {
        id
        answers
      }
    }
  }
}

Variables:

{
  "input": {
    "scholarshipId": "12345",
    "requirementId": "req-456",
    "type": "SURVEY",
    "answers": {
      "question-1": "answer-1",
      "question-2": ["choice-A", "choice-B"]
    }
  }
}

Delete an Application Requirement

Remove an already submitted requirement response.

mutation DeleteRequirement($id: ID!, $type: RequirementTypeEnum!) {
  scholarships {
    deleteApplicationRequirement(id: $id, type: $type)
  }
}

Variables:

{
  "id": "app-req-123",
  "type": "TEXT"
}

Perform a Quick Apply

Quick Apply bypasses manual requirement submission if the API already has the user's previously generated or matched responses.

mutation QuickApply($input: QuickApplyInput!) {
  scholarships {
    quickApply(input: $input) {
      scholarshipId
      created
      applicationId
    }
  }
}

Variables:

{
  "input": {
    "scholarshipId": "12345",
    "answerId": "answer-abc"
  }
}

Fetch Scholarship Application Snapshot

Retrieve the current state of an application, including all its requirements, to preview before submission.

query ApplicationSnapshot($scholarshipId: ID!) {
  scholarships {
    applicationSnapshot(scholarshipId: $scholarshipId) {
      applicationId
      status
      requirements {
        id
        type
        isOptional
      }
      submittedRequirements {
        id
        ... on ApplicationText {
          text
        }
      }
    }
  }
}