> For the complete documentation index, see [llms.txt](https://eventx-hq.gitbook.io/knowledge-base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eventx-hq.gitbook.io/knowledge-base/api-doc/outreach.md).

# Outreach

## POST /public-api/v1/event/{eventId}/outreach/email-template/confirmation-email/send

> Send confirmation emails to attendees

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/outreach/email-template/confirmation-email/send":{"post":{"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendeeIds":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true}},"required":["attendeeIds"],"additionalProperties":false,"description":"Request body for sending confirmation emails"}}}},"tags":["Outreach"],"operationId":"bulkSendConfirmationEmailByEventId","summary":"Send confirmation emails to attendees"}}}}
```

## POST /public-api/v1/event/{eventId}/outreach/email-template/{emailTemplateType}/test

> Send test confirmation emails

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/outreach/email-template/{emailTemplateType}/test":{"post":{"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"emailTemplateType","in":"path","required":true,"schema":{"type":"string","enum":["confirmation-email","confirmation-email-with-ticket-summary"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"testEmails":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":5}},"required":["testEmails"],"additionalProperties":false,"description":"Request body for sending test confirmation emails to up to 5 recipients"}}}},"tags":["Outreach"],"operationId":"sendTestConfirmationEmailByEventId","summary":"Send test confirmation emails"}}}}
```

## PUT /public-api/v1/event/{eventId}/outreach/email-template/{emailTemplateType}

> Create or update an email template

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/outreach/email-template/{emailTemplateType}":{"put":{"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"emailTemplateType","in":"path","required":true,"schema":{"type":"string","enum":["attendee-approval-acknowledgement-email","attendee-invitation-email","attendee-rsvp-email","confirmation-email","confirmation-email-with-ticket-summary","event-manager-invitation","offline-payment-invoice-email","order-summary-email","reminder-24H-email","reminder-1H-email","special-role-invitation-email"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"senderId":{"type":"string","format":"uuid"},"contentHtml":{"type":"string"},"design":{"type":"object","properties":{},"additionalProperties":false},"senderName":{"type":"string"},"subject":{"type":"string"},"shouldAttachCalendarFile":{"type":"boolean"},"shouldAttachCheckInQRCodeFile":{"type":"boolean"},"isDisabled":{"type":"boolean"},"replyToEmail":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Request body for creating or updating an email template"}}}},"tags":["Outreach"],"operationId":"upsertEmailTemplateByType","summary":"Create or update an email template"}}}}
```

## POST /public-api/v1/event/{eventId}/outreach/sms-template/confirmation-sms/send

> Send confirmation SMS to attendees

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/outreach/sms-template/confirmation-sms/send":{"post":{"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendeeIds":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true}},"required":["attendeeIds"],"additionalProperties":false,"description":"Request body for sending confirmation SMS"}}}},"tags":["Outreach"],"operationId":"bulkSendConfirmationSmsByEventId","summary":"Send confirmation SMS to attendees"}}}}
```

## POST /public-api/v1/event/{eventId}/outreach/whatsapp-template/confirmation-message/send

> Send confirmation WhatsApp messages to attendees

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/outreach/whatsapp-template/confirmation-message/send":{"post":{"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendeeIds":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true}},"required":["attendeeIds"],"additionalProperties":false,"description":"Request body for sending confirmation WhatsApp messages"}}}},"tags":["Outreach"],"operationId":"bulkSendConfirmationWhatsAppMessageByEventId","summary":"Send confirmation WhatsApp messages to attendees"}}}}
```

## POST /public-api/v1/outreach/{eventId}/manual-email/{outreachEmailId}/send

> Send a draft manual email to attendees

```json
{"openapi":"3.2.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/outreach/{eventId}/manual-email/{outreachEmailId}/send":{"post":{"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"outreachEmailId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendeeIds":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true}},"required":["attendeeIds"],"additionalProperties":false,"description":"Request body for sending a manual email to attendees"}}}},"tags":["Outreach"],"operationId":"sendManualEmailByEventId","summary":"Send a draft manual email to attendees"}}}}
```