ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
API View for bulk creating platform invitations.
This endpoint allows creating multiple platform invitations in a single request.
Request Parameters: invitation_data (list, required): List of invitation data objects, each containing: platform_key (str, required): The platform to create an invitation for email (str, required): The email address to invite active (bool, optional): Whether the invitation is active metadata fields: Any additional parameters will be added as metadata platform_key (str, required for platform admins): The platform key for permission validation
Methods: POST: Create multiple platform invitations
Returns: POST: A JSON response containing the creation results: { "successes": 5, "error_codes": [] }
Error Responses: 400 Bad Request: If required parameters are missing or invalid 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this resource 500 Internal Server Error: If an unexpected error occurs during creation
Access Control:
- Requires IsDMAdmin or IsPlatformAdmin permission
- Available to platform administrators and DM admins
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
List of invitation data objects
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/platform/bulk/
https://base.manager.iblai.app/api/catalog/invitations/platform/bulk/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/platform/bulk/ \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"invitation_data": [
{
"platform_key": "string",
"email": "user@example.com",
"username": "string",
"active": true,
"source": "string",
"redirect_to": "http://example.com",
"created": "2019-08-24T14:15:22Z",
"expired": "2019-08-24T14:15:22Z",
"metadata": {
"property1": null,
"property2": null
}
}
],
"platform_key": "string"
}'{ "successes": 0, "error_codes": [ "string" ] }
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/platform/check/
https://base.manager.iblai.app/api/catalog/invitations/platform/check/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/platform/check/?email=user%40example.com'- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/platform/redeem/
https://base.manager.iblai.app/api/catalog/invitations/platform/redeem/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/platform/redeem/ \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"platform_key": "string",
"source": "string",
"email": "user@example.com",
"username": "string",
"metadata": {
"property1": null,
"property2": null
}
}'{ "id": 0, "user_id": 0, "username": "string", "email": "user@example.com", "created": "2019-08-24T14:15:22Z", "started": "2019-08-24T14:15:22Z", "expired": "2019-08-24T14:15:22Z", "source": "string", "redirect_to": "http://example.com", "active": true, "metadata": { "property1": null, "property2": null }, "platform_key": "string" }