ibl-data-manager (3.59.0-ai-plus)

API View for creating blank program invitations.

This endpoint allows creating multiple blank program invitations (without user association) that can be redeemed later.

Request Parameters: program_key (str, required): The program to create invitations for source (str, required): The source identifier for the invitations count (int, required): The number of blank invitations to create metadata fields: Any additional parameters will be added as metadata

Methods: POST: Create multiple blank program invitations

Returns: POST: A JSON response containing the creation results: { "successes": 10, "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 IsPlatformAdminForProgram permission
• Available to DM admins and platform admins for the specific program

API View for bulk creation of program invitations.

This endpoint allows creating multiple program invitations at once.

Request Parameters: invitation_data (list, required): List of invitation data objects, each containing: program_key (str, required): The program 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 program 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

API View for redeeming blank program invitations.

This endpoint allows redeeming a blank program invitation by associating it with a user.

Request Parameters: program_key (str, required): The program key for the invitation source (str, required): The source identifier for the invitation email (str, optional): The email to associate with the invitation username (str, optional): The username to associate with the invitation metadata fields: Any additional parameters will be added as metadata

Methods: POST: Redeem a blank program invitation

Returns: POST: A JSON response containing the redeemed invitation: { "id": 123, "user_id": 456, "username": "username", "email": "user@example.com", "created": "2023-06-15T14:30:00Z", "started": "2023-06-15T14:30:00Z", "source": "source", "redirect_to": "https://example.com", "expired": null, "active": true, "metadata": {}, "program_key": "org+program1" }

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 404 Not Found: If no blank invitation is available 500 Internal Server Error: If an unexpected error occurs during redemption

Access Control:

• Requires IsDMAdmin or IsPlatformAdminForProgram permission
• Available to DM admins and platform admins for the specific program