Outreach

Send confirmation emails to attendees

post

Authorizations

AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters

eventIdstring · uuidRequired

Body

Request body for sending confirmation emails

attendeeIdsstring · uuid[]Required

Responses

204

Success

application/json

objectOptional

500

ERROR

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

POST /public-api/v1/event/{eventId}/outreach/email-template/confirmation-email/send HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "attendeeIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

{}

Send test confirmation emails

post

Authorizations

AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters

eventIdstring · uuidRequired

emailTemplateTypestring · enumRequiredPossible values:

Body

Request body for sending test confirmation emails to up to 5 recipients

testEmailsstring · email[] · min: 1 · max: 5Required

Responses

204

Success

application/json

objectOptional

500

ERROR

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

POST /public-api/v1/event/{eventId}/outreach/email-template/{emailTemplateType}/test HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "testEmails": [
    "[e-mail]"
  ]
}

{}

Create or update an email template

put

Authorizations

AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters

eventIdstring · uuidRequired

emailTemplateTypestring · enumRequiredPossible values:

Body

Request body for creating or updating an email template

senderIdstring · uuidOptional

contentHtmlstringOptional

designobjectOptional

senderNamestringOptional

subjectstringOptional

shouldAttachCalendarFilebooleanOptional

shouldAttachCheckInQRCodeFilebooleanOptional

isDisabledbooleanOptional

replyToEmailstring · nullableOptional

Responses

204

Success

application/json

objectOptional

500

ERROR

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

PUT /public-api/v1/event/{eventId}/outreach/email-template/{emailTemplateType} HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "senderName": "EventX Team",
  "subject": "Your Registration Confirmation",
  "contentHtml": "<p>Thank you for registering!</p>",
  "shouldAttachCalendarFile": true,
  "shouldAttachCheckInQRCodeFile": true,
  "isDisabled": false
}

{}

Send confirmation SMS to attendees

post

Authorizations

AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters

eventIdstring · uuidRequired

Body

Request body for sending confirmation SMS

attendeeIdsstring · uuid[]Required

Responses

204

Success

application/json

objectOptional

500

ERROR

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

POST /public-api/v1/event/{eventId}/outreach/sms-template/confirmation-sms/send HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "attendeeIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

{}

Send confirmation WhatsApp messages to attendees

post

Authorizations

AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters

eventIdstring · uuidRequired

Body

Request body for sending confirmation WhatsApp messages

attendeeIdsstring · uuid[]Required

Responses

204

Success

application/json

objectOptional

500

ERROR

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

POST /public-api/v1/event/{eventId}/outreach/whatsapp-template/confirmation-message/send HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "attendeeIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

{}

Send a draft manual email to attendees

post

Authorizations

AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters

eventIdstring · uuidRequired

outreachEmailIdstring · uuidRequired

Body

Request body for sending a manual email to attendees

attendeeIdsstring · uuid[]Required

Responses

204

Success

application/json

objectOptional

500

ERROR

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

POST /public-api/v1/outreach/{eventId}/manual-email/{outreachEmailId}/send HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "attendeeIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

{}