Recipient choices
get_recipient_choicesLists sub-choices of a hierarchical recipient group, such as classes, for legacy accounts; use the chosen item's selection_id in recipient_type for get_recipients.
Instructions
Legacy accounts only: list the sub-choices of a hierarchical recipient group, such as classes. Put the chosen item's reference.selection_id into recipient_type for get_recipients. Modern accounts return UNSUPPORTED_CAPABILITY.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account_alias | Yes | Login alias from list_accounts. | |
| recipient_type | Yes | A group's reference from get_recipient_types. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | ||
| backend | No | legacy | |
| context | Yes | ||
| identity | Yes | ||
| pagination | No | ||
| observation | Yes |