Get Recipient Count

This API used to get recipient count associated with the specified event.
API used at host side event admin and super admin can access this API. It will return total number of recipient.
To call this API, user have to pass query param with API like emailRecipients, ticketingTypeId, fetchHiddenTicketsOnly, dataType, recurringEventId and authentication key to authenticate user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Here is the description of response attributes, which returns in the form of JSON.

AttributeDescription
longIt returns the total number of recipient value which returns after Test email sent successfully.

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error codeError Description
400The request could not be understood by the server due to malformed syntax.
401You are not authorized to view the resource.
403Accessing the resource you were trying to reach is forbidden.
404The resource you were trying to reach is not found.
Path Params
string
required

Event url is unique identifier for your event. E.g https://www.accelevents.com/events/demo. Here demo is the event url.

Query Params
string
enum

email recipients must be either of ALL_CONTACTS, ALL_TICKER_HOLDER_AND_BUYERS, ALL_AUCTION_PARTICIPANTS, ALL_AUCTION_WINNERS, ALL_RAFFLE_WINNERS, ALL_FUND_A_NEED_PLEDGERS, ALL_TEXT_TO_GIVE_DONORS, BY_TICKET_TYPE_VIA, ALL_SPEAKERS, ALL_EXHIBITORS, CHECKED_IN, NOT_CHECKED_IN and ALL_RAFFLE_PARTICIPANTS.

string

Ticket Type Id to send mail if EMAIL_RECIPIENTS is BY_TICKET_TYPE_VIA

boolean
Defaults to false

Default value for a boolean is false in fetchHiddenTicketsOnly.

string
enum
Defaults to TICKET

There are two type of datatype like TICKET and ADDON . Default value for a datatype is Ticket.

Allowed:
int64
Defaults to 0

Pass recurring event id

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json