Create an experience

post

https://app.riipen.com/api/v1/experiences

Create an experience.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

applications_due_at

date-time

If applications are enabled, when the applications are due for the experience.

category_list

array of strings

An array of relevant categories tagged by the experience.

category_list

close_date

date-time

When the experience automatically closes and no longer accepts match requests from projects.

dates_controller

string

enum

What entity sets the due dates for the team.

Allowed:

deliverables

string

Rich text HTML string of final experience deliverables.

details

string

Rich text HTML string of final experience details.

end_date

date-time

When the experience ends.

examples

string

Rich text HTML string of project examples that would match well with this experience.

faculty

string

The faculty the experience is part of.

hours

integer

≥ 1

How many hours a learner should spend on the project.

in_marketplace

boolean

Whether the experience is shown in the marketplace.

industry_list

array of strings

An array of relevant industries tagged by the experience.

industry_list

learner_member_questions_enabled

boolean

Whether learners must answer questions during the application process.

learner_year_list

array of strings

An array of relevant learner years tagged by the experience.

learner_year_list

Allowed:

locale

string

The locale the experience uses.

location_preference

string

enum

How nearby matching projects should be.

Allowed:

magic_token_enabled

boolean

Whether the experience allows invites via a magic token.

match_learners_maximum

integer

The maximum number of learners per matched project.

match_request_expiry_days

integer

The number of days received requests will expire after.

match_request_pending_maximum

integer

Maximum number of received pending requests.

match_request_questions_enabled

string

Whether the project must answer questions from the experience when creating a match request.

match_teams_maximum

integer

Teams per matched project maximum.

match_unique_learners_enabled

boolean

Whether learners must be unique per matched project.

name

string

The display name of the experience.

open

boolean

Whether the experience is open to requests or not.

payments_amount_cents

integer

The amount to pay learners.

payments_currency

string

enum

The currency to pay learners.

Allowed:

payments_invoice_type

string

enum

Type of payment for the experience.

Allowed:

portal_id

string

required

ID of the associated portal.

program_code

string

The program code for the experience.

program_learner_size

integer

The amount of learners for the experience.

program_name

string

The program name for the experience.

program_type

string

enum

What type of program this experience is for.

projects_wanted

integer

≥ 1

How many projects the experience wants to match with.

skill_list

array of strings

An array of relevant skills tagged by the experience.

skill_list

start_date

string

When the experience starts.

team_creation

string

enum

How team creation is controlled.

Allowed:

team_creation_enabled

boolean

Whether learner team creation is enabled.

team_size

integer

The maximum amount of learners per team.

team_submission_description

string

Rich text HTML string of a description for team submission.

Responses

201Response to a valid request

defaultError