Get Sponsorship Categories

The "Get Sponsor Categories" API allows event organizers and portal administrators to retrieve all available sponsor tiers configured for a specific event within their Zoho Backstage portal. These sponsorship tiers typically represent category groupings like “Gold”, “Silver”, or “Diamond” and are used to define the pricing, perks, and visibility levels associated with each sponsor. This endpoint helps organizers review and manage the sponsor benefits associated with each category, enabling better tier assignment and consistent benefit tracking.

Header:

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

OAuth Scope

zohobackstage.sponsor.READ

Path Parameters

• portal_id (Integer)
  The unique identifier of your Zoho Backstage portal. This determines the source portal from which sponsor categories will be fetched. For example, "portal_id": 32393793 specifies that sponsor categories are being retrieved from this portal.
• event_id (Integer)
  The unique identifier of the event for which sponsor categories are configured. For example, "event_id": 2000000000026 indicates that sponsor tiers will be fetched for this specific event.

Response Structure and Field Explanations

A successful API call returns a JSON object containing a list of all sponsor categories created for the event. Each category includes details such as its name, cost, associated benefits, and metadata about the user who created or last modified the record.

• sponsorship_types (Array)
  An array containing all sponsor categories associated with the event. Each item in the array represents a sponsor tier and its associated benefits. Each item inside sponsorship_types includes the following fields:

  • id (String)
    The unique identifier assigned to the sponsor category. For example, "id": "2000000021001" is the internal system ID for a sponsor tier like Diamond or Gold.

  • name (String)
    The name of the sponsor category. This typically indicates the level or tier of sponsorship such as “DIAMOND”, “GOLD”, or “SILVER”. For example, "name": "DIAMOND" specifies that the sponsor tier is labeled as Diamond.

  • amount (Integer)
    The cost associated with the sponsorship category. This represents the fee charged to sponsors enrolling under this tier. For example, "amount": 1500" indicates that sponsors under this category are billed 1500 units of the specified currency.

  • currency_code (String)
    The ISO 4217 currency code that denotes the billing currency. For example, "currency_code": "USD" shows that the amount is listed in US Dollars.

  • benefits (Array)
    An array of benefit objects associated with the sponsor category. Each object defines a specific benefit and whether it is included for sponsors under this tier. Each object inside the benefits array includes the following fields:

    • id (String)
      The unique identifier for the benefit assigned to the sponsor category. For example, "id": "2000000030001" represents a benefit like “Chairs”.

    • name (String)
      The name of the benefit provided to sponsors under this category. For example, "name": "Chairs" specifies that the benefit includes providing chairs.

    • is_enabled (Boolean)
      Indicates whether the benefit is enabled for the sponsor category. For example, "is_enabled": true means this benefit is active for the given tier.

    • message (String)
      Additional notes or specifications related to the benefit, if available. For example, "message": "5 Nos." specifies that the sponsor is entitled to five chairs.

  • createdBy (Object)
    Details of the user who created the sponsor category. This object includes metadata such as the user’s ID, name, email address, company, and designation, if available.

    • id (String)
      The unique identifier of the user who created the sponsor category. For example, "id": "2000000000001" identifies the creator of the record.

    • email (String)
      The email address of the user who created the sponsor category. For example, "email": "john.doe@company.com" is the creator’s contact email.

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

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

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

  • createdTime (String)
    The timestamp indicating when the sponsor category was created. This value follows the ISO 8601 format in UTC. For example, "createdTime": "2025-03-21T05:36:04Z" shows when the record was initially created.

  • lastModifiedBy (Object)
    Details of the user who last modified the sponsor category. This object includes metadata such as the user’s ID, name, email address, company, and designation, if available.

    • id (String)
      The unique identifier of the user who last modified the sponsor category. For example, "id": "2000000000001" indicates the user who last updated the record.

    • email (String)
      The email address of the user who last modified the record. For example, "email": "john.doe@company.com" shows the contact email of the modifying user.

    • first_name (String)
      The display name or first name of the user who performed the modification. For example, "first_name": "John" identifies the name of the user.

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

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

  • lastModifiedTime (String)
    The timestamp indicating when the sponsor category was last updated. This is also formatted in ISO 8601 UTC. For example, "lastModifiedTime": "2025-03-21T05:36:28Z" reflects the last modification time for the record.