API docs by Redocly

2belive - External API (1.0.0)

Download OpenAPI specification:Download

external_api

new_user

header Parameters
accessToken
string

accessToken generated from our backoffice. Required permissions: create account

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "email": "newuser_2023@gmail.com",
  • "role_name": "student",
  • "group_permission_ids": [ ],
  • "create_account": true
}

new_user_or_sign_in

header Parameters
accessToken
string
Example: {{ACCESSTOKEN}}
Request Body schema: application/json
email
string

E-mail for the account being created

role_name
string

Role for the account. Possible values are student, admin or teacher

group_permission_ids
Array of integers

Groups the account will be added to. Array of integer ids. If none is provided, account is still being added to the default (free) group

Responses

Request samples

Content type
application/json
{
  • "email": "newuser_2025abc@gmail.com",
  • "role_name": "student",
  • "group_permission_ids": [ ]
}

Response samples

Content type
application/json
{
  • "user": { },
  • "magic_link": "string"
}

create_purchase

header Parameters
accessToken
string
Example: {{ACCESSTOKEN}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "type": "catalog",
  • "item_id": 2629,
  • "price": 123,
  • "user_id": 23956,
  • "external_id": "my-transaction_token",
  • "metadata": [
    ]
}

create_userpurchase

header Parameters
accessToken
string
Example: {{ACCESSTOKEN}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "email": "gandrade@2mundos.net",
  • "external_id": "my-transaction_token",
  • "metadata": [
    ]
}