APIDeveloperClassApp WebFale Conosco
Log in

Onboarding
Onboarding Type for GraphQL Queries




POST as x-www-form-urlencoded:

https://joy.classapp.co/graphql?access_token=YOUR_TOKEN_HERE&client_id=YOUR_CLIENT_ID


Onboarding

ParamsDescription
idThe ID of an object
dbIdIdentifies the primary key from the database.
step
studentJsonJSON containg the data inserted on the STUDENT Step of the Onboarding
channelJsonJSON containg the data inserted on the CHANNEL Step of the Onboarding
organizationIdOrganization that onboarding belongs to
organizationOrganization that onboarding belongs
createdAn ISO-8601 encoded UTC date string of when record was created
modifiedAn ISO-8601 encoded UTC date string of when record was updated
deletedAn ISO-8601 encoded UTC date string of when record was deleted
keyRandom ID to differentiate from others
selectedHelper field for clients
highlightedHelper field for clients
expandedHelper field for clients
loadedHelper field for clients
loadingHelper field for clients

CreateOnboardingInput

ArgumentsTypeDescription
organizationId
Not Null
The organization ID that onboarding belongs to
step
Not Null
studentJson
String
SCALAR
JSON containg the data inserted on the STUDENT Step of the Onboarding
channelJson
String
SCALAR
JSON containg the data inserted on the CHANNEL Step of the Onboarding
clientMutationId
String
SCALAR

UpdateOnboardingInput

ArgumentsTypeDescription
id
Not Null
The ID of a Onboarding object
step
OnboardingStep
ENUM
studentJson
String
SCALAR
JSON containg the data inserted on the STUDENT Step of the Onboarding
channelJson
String
SCALAR
JSON containg the data inserted on the CHANNEL Step of the Onboarding
clientMutationId
String
SCALAR

DeleteOnboardingInput

ArgumentsTypeDescription
id
Not Null
The ID of a Onboarding object
finishOnboarding
Boolean
SCALAR
Finishing onboarding
sendInvites
Boolean
SCALAR
send invites after finishing onboarding
clientMutationId
String
SCALAR