Update an individual onboarding

Update individual onboardings using the API.

Prerequisites

• You must have a project access token.
• The onboarding status must be Ongoing (valid or invalid).

Guide

To test updating an individual onboarding, add an account name.

1. First, retrieve the ID for the onboarding you need to update.
2. Call the updateIndividualOnboarding mutation.
3. Enter the onboarding ID retrieved in step 1.
4. Check the box for accountName, then add an account name (example: MyBrand).
5. Add desired messages to the success payload, either for validation or in case of rejection.
   • Recommendation: Inside the UpdateIndividualOnboardingSuccessPayload option, add onboardingState and statusInfo > status to confirm the onboarding is still ongoing and valid after making the update.

Mutation

🔎 Open the mutation in API Explorer

mutation UpdateIndividualOnboarding {
  updateIndividualOnboarding(
    input: {
      onboardingId: "$ONBOARDING_ID"
      accountName: "Personal account"
    }
  ) {
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on InternalErrorRejection {
      __typename
      message
    }
    ... on UpdateIndividualOnboardingSuccessPayload {
      __typename
      onboarding {
        accountName
        onboardingState
        statusInfo {
          status
        }
      }
    }
    ... on ValidationRejection {
      __typename
      message
      fields {
        message
      }
    }
  }
}

Payload

{
  "data": {
    "updateIndividualOnboarding": {
      "__typename": "UpdateIndividualOnboardingSuccessPayload",
      "onboarding": {
        "accountName": "MyBrand",
        "onboardingState": "Ongoing",
        "statusInfo": {
          "status": "Valid"
      }
    }
  }
}