Invite Users

post

https://api.vygoapp.com/users/invite

This request will allow you to invite users to the Vygo platform. Each user will receive an email with details on how to access the Vygo platform. If an email provided (or the Student ID or External ID) already has a Vygo account associated, they will not receive an invite email.

IMPORTANT: Fields within the user object are optional. Any fields provided will be used to pre-fill the associated onboarding questions. Data provided must be an exact match to onboarding answers in the Vygo platform.

Headers

x-api-key

string

required

You must provide your API key in the header of each request.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Request accepted for proccessing The count of valid emails does not indicate the number of invites sent. Valid emails will be sent for processing. If an email is already associated with an existing account it won't be sent an invite.

401API key missing or incorrect

403Forbidden

406Data provided is incorrect

429Rate limit or concurrency exceeded