# Outreach

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

> Send confirmation emails to attendees

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"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":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Outreach"],"operationId":"bulkSendConfirmationEmailByEventId","summary":"Send confirmation emails to attendees","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendeeIds":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true}},"required":["attendeeIds"],"additionalProperties":false}}}}}}}}
```

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

> Send test confirmation emails

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"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":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"},{"schema":{"type":"string","enum":["confirmation-email","confirmation-email-with-ticket-summary"]},"name":"emailTemplateType","in":"path"}],"tags":["Outreach"],"operationId":"sendTestConfirmationEmailByEventId","summary":"Send test confirmation emails","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"testEmails":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":5}},"required":["testEmails"],"additionalProperties":false}}}}}}}}
```

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

> Create or update an email template

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"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":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"},{"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"]},"name":"emailTemplateType","in":"path"}],"tags":["Outreach"],"operationId":"upsertEmailTemplateByType","summary":"Create or update an email template","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","null"]}},"additionalProperties":false}}}}}}}}
```

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

> Send confirmation SMS to attendees

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"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":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Outreach"],"operationId":"bulkSendConfirmationSmsByEventId","summary":"Send confirmation SMS to attendees","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendeeIds":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true}},"required":["attendeeIds"],"additionalProperties":false}}}}}}}}
```

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

> Send confirmation WhatsApp messages to attendees

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"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":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Outreach"],"operationId":"bulkSendConfirmationWhatsAppMessageByEventId","summary":"Send confirmation WhatsApp messages to attendees","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendeeIds":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true}},"required":["attendeeIds"],"additionalProperties":false}}}}}}}}
```

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

> Send a draft manual email to attendees

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"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":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"},{"schema":{"type":"string","format":"uuid"},"name":"outreachEmailId","in":"path"}],"tags":["Outreach"],"operationId":"sendManualEmailByEventId","summary":"Send a draft manual email to attendees","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendeeIds":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true}},"required":["attendeeIds"],"additionalProperties":false}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://eventx-hq.gitbook.io/knowledge-base/api-doc/outreach.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.