API Reference

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.

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

Attribute

Description

long

It 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 code

Error Description

400

The request could not be understood by the server due to malformed syntax.

401

You are not authorized to view the resource.

403

Accessing the resource you were trying to reach is forbidden.

404

The resource you were trying to reach is not found.

Language
Credentials
Header
Click Try It! to start a request and see the response here!