create_draw
Creates a Secret Santa / Amigo Invisible / Amigo Secreto / gift exchange draw and pairs the participants randomly, honouring exclusion rules (e.g. couple-couple, sibling-sibling). The first participant in the list is the organizer. The required inputs are the date and at least 3 participants; the budget, the exclusions, a personal invitation message and the locale are optional. The draw is created immediately and cannot be modified from this server afterwards. The result returns the draw id and its share code, and lists two ways to invite the participants: send_invitations_email (an email to each participant) or get_group_share_message (a message to paste into a group chat).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | Date of the draw, in YYYY-MM-DD format. | |
| price | No | Optional gift budget, free text. Examples: "20€", "$25". | |
| locale | No | Optional BCP 47 language tag for the user (e.g. "es-ES", "es-MX", "es-AR", "en-GB"). It determines the Secret Santa Raffle brand (website) and the language of the message templates and emails: arguments.locale takes precedence, then the Accept-Language header, then Secret Santa (English) when neither is present or supported. Brands: Amigo Invisible (Spain/Argentina/Uruguay), Amigo Secreto (most of Latin America), Intercambio de regalos (Mexico), Secret Santa (English and global fallback). | |
| message | No | Optional invitation email body. If omitted, a localized default is used. The placeholder "ParticipanteX" is replaced with each recipient name. | |
| drawName | No | Optional. If omitted, a localized default is generated (e.g. "Amigo Invisible 2026", "Amigo Secreto 2026", "Intercambio de regalos 2026", or "Secret Santa 2026"). | |
| participants | Yes | Minimum 3 participants. The first is the organizer. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | ||
| brand | Yes | ||
| price | No | ||
| drawId | Yes | ||
| drawName | Yes | ||
| shareCode | Yes | ||
| widgetLabels | No | ||
| organizerName | Yes | ||
| participantCount | Yes |