Grant access by email - MSAAQ Documentation

This endpoint is used to grant access to one or more courses or products to a member using their email.

✅ Behavior

If the user does not exist, a new member will be created using the provided email and optional fields.

If the user already exists, the system will simply grant access to the specified courses/products.

If password is null, the user can log in via OTP or SSO (if your system supports it).

No duplicate access will be created if the user already has access to a product.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

string

required

Example:

application/json

X-Tenant

string

required

Example:

Body Params application/json

string

required

The member email address. If the user does not exist, an account will be created.

Example:

name@example.com

products

array [object {2}] | null

optional

Array of access objects containing id and type. Each object represents a course or product to grant access to.

string

required

The ID of the course or product to grant access to.

type

enum<string>

required

Type of the item: course or product. Use course for any course or learning path, and product for digital products like downloads, bundles, coaching, etc.

Allowed values:

courseproduct

first_name

string | null

optional

First name of the member.

last_name

string | null

optional

Last name of the member.

password

string | null

optional

Optional password for the account. If null, the member will log in using OTP or SSO (if configured).

phone_code

string | null

optional

International dialing code (e.g., +966).

phone

string | null

optional

Phone number of the member.

with_auth_url

boolean

optional

If set to true, the response will include a passwordless login URL for the member.

segments

array[string] | null

optional

Segments name or ID

Example

{
  "email": "info@msaaq.com",
  "products": [
    {
      "id": "114",
      "type": "course"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

message

object (SuccessResponseMessage)

required

title

string | null

optional

body

string

required

data

object

required

new_account_created

boolean

required

Indicates if the account was newly created (true) or already existed (false)

granted_access_count

integer

required

Number of courses/products access was successfully granted to.

auth_url

string | null

optional

Only present if with_auth_url is true. A passwordless login link for the member.

member

object (MemberResource)

required

Example

{
  "message": {
    "body": "تمّ منح المتدرب الوصول المطلوب."
  },
  "data": {
    "new_account_created": false,
    "granted_access_count": 0,
    "auth_url": "https://academy.example.com/passwordless?url=https%3A%2F%2Fmsaaq.test%2Fv1%2Ftenant%2Fauth%2Fpasswordless%3Facademy_id%3D1%26expires%3D1742907118%26user_id%3D551149%26signature%3D841aafd123cd6d54595d4e6bf454fe605e3768643ed02c7ba2e6c7d308899081&success_redirect_url=%2F",
    "member": {
      "id": 551149,
      "first_name": "Alex",
      "last_name": "Towne",
      "name": "Alex Towne",
      "english_name": null,
      "username": "52a9ba7b-9f3e-4adc-8aea-8e304046cee6",
      "avatar": null,
      "points": 0,
      "bio": null,
      "job_title": null,
      "education": null,
      "url": "https://msaaqacademy.test/@52a9ba7b-9f3e-4adc-8aea-8e304046cee6",
      "courses_count": null,
      "products_count": null,
      "total_purchases": null,
      "orders_count": null,
      "national_id": null,
      "country_code": null,
      "currency": "",
      "gender": null,
      "skills": null,
      "email": "name@example.com",
      "phone_code": 966,
      "phone": 575315110,
      "international_phone": "966575315110",
      "dob": null,
      "email_verified_at": null,
      "phone_verified_at": null,
      "is_verified": false,
      "status": "active",
      "newsletter_status": "subscribed",
      "newsletter_subscribed_at": "2024-07-18 16:10:45",
      "newsletter_unsubscribed_at": null,
      "balance": "0.00",
      "last_seen_at": null,
      "updated_at": "2025-03-25 15:14:39",
      "created_at": "2025-03-25 15:14:39",
      "meta": null
    }
  }
}