V1::InvitationsController

Invite

create

Create and invite student or collaborator. If user exists, just invite. For stundents this endpoint will create a registration too.

URL

POST /invitations

Parâmetros obrigatórios

Nome Tipo Descrição
invitation Hash

The invitation to create

invitation[first_name] String
invitation[last_name] String
invitation[email] String
invitation[password] String
invitation[password_confirmation] String

Parâmetros opcionais

Nome Tipo Descrição
invitation[cpf] String
invitation[phone] String
invitation[skype] String
invitation[twitter] String
invitation[facebook] String
invitation[company_name] String
invitation[company_position] String
invitation[born_at] DateTime
invitation[biography] String
invitation[cover_image_url] String
invitation[created_at] String
invitation[enrollments] Hash

The enrollments to create

invitation[enrollments][enrollment[unlimited]] Boolean

Says if the enrollment is unlimited [true, false]

invitation[enrollments][enrollment[registration_id]] Integer

Identifier of the Registration object

invitation[enrollments][enrollment[available_until]] DateTime

Date of enrollment's expiration. Required if enrollment[unlimited] is false

invitation[enrollments][enrollment[created_at]] DateTime

Date of creation

invitation[enrollments][enrollment[activated_at]] DateTime

Date of activation

invitation[enrollments][enrollment[code]] String

Representation code of enrollment (uniq)

invitation[enrollments][enrollment[course_class_ids]] Array<Integer>

An array of course classes ids to associate to the enrollment