Create an Exhibitor

The Create an Exhibitor API allows event organizers to add a new exhibitor to a specific event in their Zoho Backstage portal. This endpoint enables the association of detailed company information, booth allocation, contact details, financial data, and social media handles. It is primarily used by portal admins to onboard exhibitor organizations participating in an event.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

OAuth Scope

zohobackstage.exhibitor.CREATE

Path Parameters

• portal_id (Integer): 
  The unique identifier of your Zoho Backstage portal. This tells the system under which portal the exhibitor is being added. For example, if your portal ID is 19593237, all associated events and modules fall under that portal.
• event_id (Integer):
  The unique ID of the event in which the exhibitor will be added. For example, an event ID like 20000000345678 could represent your upcoming product expo.

Payload Parameters  

The request payload must be in JSON format and should include the following fields:

• exhibitor_category_id (String)
  The ID of the category under which the exhibitor is grouped. Categories help in organizing exhibitors into logical sections such as "Platinum Sponsors", "Technology Partners", or "Food Stalls". For example, "exhibitor_category_id": "2000000013067" indicates that the exhibitor belongs to the specified category.
• company_name (String)
  The full name of the company being added as an exhibitor. This name will appear in the exhibitor listing on the event website. For example, "company_name": "Zoho Corporation" displays "Zoho Corporation" in the exhibitor section.
• website_url (String)
  The official website URL of the exhibitor. Attendees can use this link to learn more about the company and its offerings. For example, "website_url": "https://www.zoho.com" directs attendees to the Zoho Corporation website.
• booth_label (String)
  The label assigned to the exhibitor’s booth. This helps attendees and organizers locate the exhibitor’s physical or virtual stall during the event.
  For example, "booth_label": "A12" assigns booth A12 to the exhibitor.
• amount (Integer)
  The amount paid or billed to the exhibitor. This can include fees for booth space, promotional upgrades, or other services. For example, "amount": 500 indicates that the exhibitor is billed 500 units of the specified currency.
• currency_code (String)
  The three-letter ISO currency code that denotes the currency used in the amount field.
  For example, "currency_code": "USD" indicates that the amount is in US Dollars.
• contact (Object)
  A nested object containing the primary contact person’s information for the exhibitor. This information is used for all event-related communication and updates. The following fields are included within the contact object:
  • first_name (String)
    The first name of the contact person. For example, "first_name": "John" specifies that the contact's first name is John.
  • last_name (String)
    The last name of the contact person. For example, "last_name": "Doe" specifies that the contact's last name is Doe.
  • email (String)
    The email address used for correspondence with the contact person. For example, "email": "john.doe@company.com" indicates the contact’s email ID.
  • designation (String)
    The job title or role of the contact person within the exhibitor's organization. For example, "designation": "Marketing Head" specifies the contact’s designation.
  • mobile_no (String)
    The mobile number of the contact person for direct communication. For example, "mobile_no": "9876543210" is the contact’s phone number.
• company_overview (String)
  A detailed description of the company’s mission, services, and background. This content helps attendees learn more about the exhibitor.
  For example, "company_overview": "Zoho is a global technology company offering a suite of cloud-based productivity tools." provides an overview of the exhibitor.
• company_short_description (String)
  A concise summary of the company profile suitable for limited space displays, such as mobile apps or event kiosks. For example, "company_short_description": "Global tech leader in cloud apps." gives a quick snapshot of the exhibitor.
• company_social_pages (Object)
  An object that contains URLs of the exhibitor’s social media profiles. These links can be used to display social handles on the event site for networking and branding purposes. For example, "company_social_pages": { "facebook": "https://www.facebook.com/zoho" } links to the exhibitor’s Facebook page.

Response Structure and Field Explanations

A successful API call returns a JSON response containing the details of the newly created exhibitor along with metadata such as creation time and user information.

• id (String)
  The unique identifier assigned to the exhibitor record. This ID is auto-generated by the system upon successful creation of an exhibitor. For example, "id": "2000000020001" represents the unique ID of the exhibitor.

• booth_id (String)
  The internal system ID of the booth allocated to the exhibitor. This ID is used to reference booth details within the portal. For example,  "booth_id": "2000000013071" indicates that the exhibitor has been assigned this booth.

• company_name (String)
  The full name of the exhibitor's organization as displayed on the event website and promotional material. For example, "company_name": "Zoho Corporation" represents the exhibitor’s company name.

• website_url (String)
  The official website of the exhibitor’s company. Attendees can visit this link to learn more about the company’s products or services. For example, "website_url": "www.zoho.com" directs users to the exhibitor’s online presence.

• amount (Integer)
  The total amount billed or paid by the exhibitor. This value may cover booth space, sponsorship packages, or other services. For example, "amount": 500" indicates the exhibitor has been billed 22 units of the specified currency.

• currency_code (String)
  The three-letter ISO code representing the currency used in the amount field. For example, "currency_code": "USD" indicates that the amount is in US Dollars.

• contact (Object)
  A nested object containing the primary contact person's details for the exhibitor. This information is used for communication regarding the event.

  • first_name (String)
    The first name of the exhibitor’s contact person. For example, "first_name": "John" represents the contact’s given name.

  • last_name (String)
    The last name of the exhibitor’s contact person. For example, "last_name": "Doe" represents the contact’s surname.

  • email (String)
    The contact person’s email address used for correspondence. For example, "email": "john.doe@company.com" is the email used for event-related updates.

  • mobile_no (String)
    The contact person’s mobile number for direct communication. For example, "mobile_no": "9876543210" is the number provided for calls or messages.

• company_overview (String)
  A detailed description of the exhibitor’s business, mission, or offerings. This helps attendees gain insight into what the company represents. For example, "company_overview": "Zoho is a global technology company offering a suite of cloud-based productivity tools." provides a summary of the company.

• company_short_description (String)
  A brief description of the company used in places with limited display space, such as mobile apps or kiosks. For example, "company_short_description": "Global tech leader in cloud apps." offers a compact version of the overview.

• company_social_pages (Object)
  An object containing links to the exhibitor’s social media profiles. These links are used to improve visibility and networking on the event platform.
  For example, "company_social_pages": {  "facebook": "https://www.facebook.com/zoho", "linkedin": "https://www.linkedin.com/company/zoho" } provides the URL to the exhibitor’s Facebook and LinkedIn pages.

• created_by (Object)
  Details of the user who created the exhibitor entry in the system.

  • id (String)
    The user ID of the creator. For example, "id": "2000000000001" identifies the user who added the exhibitor.

  • email (String)
    The email address of the creator. For example, "email": "john.doe@company.com" is the account that created the entry.

  • first_name (String)
    The display name or first name of the user who created the entry. For example, "first_name": "John" indicates the user’s display name.

  • company (String or null)
    The company associated with the user. May be null if not set. For example, "company": null" shows that no company was specified.

  • designation (String or null)
    The job title of the user. May be null if not set. For example, "designation": null" indicates no title was provided.

• created_time (String)
  The timestamp indicating when the exhibitor was first created. This is in ISO 8601 format. For example, "created_time": "2025-03-21T06:14:21Z" marks the creation date and time in UTC.

• last_modified_by (Object)
  Details of the user who last updated the exhibitor record. The structure matches the created_by object.

  • id (String)
    The ID of the user who made the most recent changes. For example, "id": "2000000000001" is the same user who created and updated the entry.

  • email (String)
    The email address of the modifying user. For example, "email": "john.doe@company.com" reflects the user responsible for the update.

  • first_name (String)
    The name of the user who last modified the record. For example, "first_name": "John" is the name of the modifier.

  • company (String or null)
    The company of the user, if available. For example, "company": null" means no company is linked to the user.

  • designation (String or null)
    The designation of the user, if available. For example, "designation": null" shows that no designation was provided.

• last_modified_time (String)
  The timestamp indicating when the exhibitor was last modified. This follows the ISO 8601 format in UTC.
  For example, "last_modified_time": "2025-03-21T06:14:21Z" marks the time of the latest update.