Quick invitation page
Documentation of the quick invitation page, and its query string parameters
Base URL
The base URL of the quick invitation page is: https://cloud.apizee.com/quick-invitation
Query String parameters
Add the following parameters in the query parameters in the URL to pass information or configure behavior of the invitation page:
Displays a non-editable label with a client reference.
String (max 50 characters)
If provided, displays the reference as a label. Strings longer than 50 characters are truncated. Not displayed if no service is preselected.
Preselects a service in the invitation dropdown.
Alphanumeric (32 characters)
If valid, the corresponding service is preselected. If invalid, no preselection occurs, and a warning is logged. Overrides previously used services.
Prepopulates the "Invited Guests" field with phone numbers.
Comma-separated phone numbers
Valid numbers are added to the field. Invalid numbers are flagged with an error.
Prepopulates the "Invited Guests" field with email addresses.
Comma-separated email addresses
Valid emails are added to the field. Invalid emails are flagged with an error.
Makes the service dropdown field read-only.
Boolean (true or false)
If true, the service dropdown cannot be edited.
Makes the recipients field read-only.
Boolean (true or false)
If true, the recipient field cannot be edited.
reference
referenceDisplays as a non-editable label if provided in the URL.
Truncated to 50 characters if the string exceeds the limit.
Only displayed and used for services of type video-assistance.
/quick-invitation?reference=ABC123
Displays "Reference: ABC123" as a non-editable label.
/quick-invitation?reference=LongStringExceeding50Chars
Displays the first 50 characters of the reference string.
service_key
service_keyPreselects the specified service in the dropdown if valid.
Overrides previously used services.
/quick-invitation?service_key=9447243e889a783488c4369ccfdc0f4
Preselects the service corresponding to the key.
/quick-invitation?service_key=invalidkey
No service preselected.
phone_numbers
phone_numbersPrepopulates the "Guests" field with valid numbers.
/quick-invitation?phone_numbers=0612345678
Adds 0612345678 to the "Invited Guests" field.
/quick-invitation?phone_numbers=0612,+33612345678
Adds 0612 (flagged as invalid), adds +33612345678.
email_addresses
email_addressesPrepopulates the "Guests" field with valid email addresses.
/quick-invitation?email_addresses=user@example.com
Adds user@example.com to the "Guests" field.
/quick-invitation?email_addresses=user@,valid@email.com
Adds user@ (flagged as invalid), adds valid@email.com
read_only.service
read_only.serviceWhen true, the service dropdown becomes uneditable.
/quick-invitation?read_only.service=true
The service dropdown is disabled and cannot be changed.
read_only.recipients
read_only.recipientsWhen true, the "Guest" field becomes uneditable.
/quick-invitation?read_only.recipients=true
The "Guest" field is disabled and cannot be changed.
Last updated