New User Assessments

Use the newUserAssessments mutation to obtain all available assessment URLs for the user.

A new user profile will be created if the provided email doesn't match an existing user.

Arguments

ArgumentTypeDescription

email

String!

User's email. If the email isn't found, a new User will be created.

externalId

String

Optional external ID. If an external ID already exists for the user, the value will be overwritten.

assessment

ID

Optional assessment Id to filter results.

Available Fields

Field NameTypeDescription

UserId

ID

The user's ID

externalId

ID

User's external ID

assessments

[Assessment

Assessment's information

Example

mutation($input: NewUserAssessmentsInput!) {
    newUserAssessments(input: $input) {
        success 
        message 
        userId 
        externalId
        assessments {
            edges {
                node {
                    id 
                    title
                    url
                }
            }
        }
    }
}

variables = {
 {'input': 
    {'email': 'tester@test.com', 
    'externalId': '8b62865d-229d-41dc-8af6-99f6f7a35010'
    }}
}

Example with Assessment Filter

mutation($input: NewUserAssessmentsInput!) {
    newUserAssessments(input: $input) {
        success 
        message 
        userId 
        externalId
        assessments {
            edges {
                node {
                    id 
                    title
                    url
                }
            }
        }
    }
}

variables = {
 {'input': 
    {'email': 'tester@test.com', 
    'externalId': '8b62865d-229d-41dc-8af6-99f6f7a35010', 
    'assessment': 'QXNzZXNzbWVudDowZTRjYTY0NC04YzcxLTQ1YzctYWYwMC1lOWQzNjc4ODc4NTU='
    }}
}

Last updated