Create a speaker

The "Create a Speaker" API allows users to create a speaker profile for their event within their Zoho Backstage portal. Users must provide the portal_id and event_id to create a new speaker profile associated with a specific event.

 

 Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

 

OAuth Scope

zohobackstage.speaker.CREATE

 

Path Parameters   

  • portal_id (Long Integer)
    The unique identifier of the portal where you want to create the speaker profile. For example, "portal_id": "19593237" specifies the portal with ID 19593237.
     
  • event_id (Long Integer)
    The unique identifier of the event for which you want to create a speaker profile. For example, "event_id": "3000000000022" specifies the event with ID 3000000000022.

 

Payload Parameters

The request payload requires the following fields to create a speaker profile:

  • email* (String)
    The email address of the speaker. For example, "email": "sam@zoho.com" specifies the speaker's email as sam@zoho.com.
  • name* (String)
    The first name of the speaker. For example, "name": "Sam" identifies the speaker's first name as Sam.
  • last_name (String)
    The last name of the speaker. For example, "last_name": "Peter" identifies the speaker's last name as Peter.
  • country (String)
    The 2-character country code representing the speaker's country. For example, "country": "IN" specifies the speaker is from India.
  • featured (Boolean)
    This field indicates whether the speaker is featured. For example, "featured": true indicates that the speaker is featured.
  • company (String)
    The company where the speaker works. For example, "company": "ZOHO" indicates that the speaker works at ZOHO.
  • designation (String)
    The speaker's designation within their company. For example, "designation": "Manager" identifies the speaker's job title as Manager.
  • description (String)
    A brief description of the speaker. For example, "description": "Expert in marketing strategies" provides a description of the speaker.
  • telephone (String)
    The speaker's telephone number. For example, "telephone": "1234567890" provides the speaker's phone number.
  • alternate_telephone (String)
    An alternate phone number for the speaker. For example, "alternate_telephone": "9876543210" provides an additional contact number.
  • skills (String)
    The skills of the speaker. For example, "skills": "Marketing, Public Speaking" lists the speaker's skills.
  • twitter (String)
    The Twitter handle of the speaker. For example, "twitter": "https://twitter.com/Zoho".
  • facebook (String)
    The Facebook handle of the speaker. For example, "facebook": "https://www.facebook.com/zoho".
  • telegram (String)
    The Telegram handle of the speaker. For example, "telegram": "https://telegram.org/zoho".
  • linkedin (String)
    The LinkedIn profile URL of the speaker. For example, "linkedin": "https://in.linkedin.com/company/zoho".
  • instagram (String)
    The Instagram handle of the speaker. For example, "instagram": "https://www.instagram.com/zoho".
  • medium (String)
    The Medium handle of the speaker. For example, "medium": "https://medium.com/@zoho".

 

Response Structure and Field Explanations   

The response provides a JSON object containing the details of the newly created speaker. Below are the fields included in the response, along with explanations:

  • id (Long Integer)
    The unique identifier assigned to the speaker. For example, "id": "20000000221001" identifies the speaker with ID 20000000221001.
  • email (String)
    The email address of the speaker. For instance, "email": "sam@zoho.com" specifies that the speaker's email is sam@zoho.com.
  • first_name (String)
    The first name of the speaker. For example, "first_name": "Sam" identifies the speaker's first name as Sam.
  • last_name (String)
    The last name of the speaker. For example, "last_name": "Peter" identifies the speaker's last name as Peter.
  • country (String)
    The 2-character country code representing the speaker's country. For example, "country": "IN" specifies the speaker is from India.
  • status (Integer)
    This field represents the current status of the speaker. Possible values include:
    • 0 - Invited

    • 1 - Joined

  • status_string (String)
    A textual representation of the speaker's status. For example, "status_string": "invited" indicates that the speaker is invited.
  • featured (Boolean)
    This field indicates whether the speaker is featured. For example, "featured": true indicates that the speaker is featured.
  • joined_on (String)
    The date and time when the speaker was created. For example, "joined_on": "2024-04-04T06:46:39Z" specifies the exact date and time the speaker was created.
  • added_on (String)
    The date and time when the speaker was added to the event. For example, "added_on": "2024-04-04T06:46:05Z" specifies when the speaker was added.
  • company (String)
    The company where the speaker works. For example, "company": "ZOHO" indicates that the speaker works at ZOHO.
  • designation (String)
    The speaker's designation within their company. For example, "designation": "Manager" identifies the speaker's job title as Manager.
  • description (String)
    A brief description of the speaker. For example, "description": "Expert in marketing strategies" provides a description of the speaker.
  • skills (String)
    The skills of the speaker. For example, "skills": "Marketing, Public Speaking" lists the speaker's skills.
  • telephone (String)
    The speaker's telephone number. For example, "telephone": "1234567890" provides the speaker's phone number.
  • alternate_telephone (String)
    An alternate phone number for the speaker. For example, "alternate_telephone": "9876543210" provides an additional contact number.
  • twitter (String)
    The Twitter handle of the speaker. For example, "twitter": "https://twitter.com/Zoho".
  • facebook (String)
    The Facebook handle of the speaker. For example, "facebook": "https://www.facebook.com/zoho".
  • telegram (String)
    The Telegram handle of the speaker. For example, "telegram": "https://telegram.org/zoho".
  • linkedin (String)
    The LinkedIn profile URL of the speaker. For example, "linkedin": "https://in.linkedin.com/company/zoho".
  • instagram (String)
    The Instagram handle of the speaker. For example, "instagram": "https://www.instagram.com/zoho".
  • medium (String)
    The Medium handle of the speaker. For example, "medium": "https://medium.com/@zoho".

URL

Copied/v3/portals/{portal_id}/events/{event_id}/speakers

Example

Copiedhttps://zohoapis.com/backstage/v3/portals/19593237/events/2000000116588/speakers

Sample Payload

Copied{
  "email": "sam@zoho.com",
  "name": "sam",
  "last_name": "peter",
  "country": "IN",
  "featured": true,
  "company": "ZOHO",
  "designation": "Manager",
  "description": "Description added",
  "telephone": "1234567890",
  "alternate_telephone": "9876543210",
  "skills": "Sales,Marketing",
  "twitter": "https://twitter.com/Zoho",
  "facebook": "https://www.facebook.com/zoho",
  "telegram": "https://telegram.org/zoho",
  "linkedin": "https://in.linkedin.com/company/zoho",
  "instagram": "https://www.instagram.com/zoho",
  "medium": "https://medium.com/@zoho"
}

Sample Response

Copied{
  "id": "20000000221001",
  "email": "sam@zoho.com",
  "first_name": "sam",
  "last_name": "peter",
  "country": "IN",
  "status": 0,
  "status_string": "invited",
  "featured": true,
  "joined_on": "2024-04-04T06:46:07Z",
  "added_on": "2024-04-04T06:46:05Z",
  "company": "ZOHO",
  "designation": "Manager",
  "description": "Description added",
  "skills": "Sales,Marketing",
  "telephone": "9988776655",
  "alternate_telephone": "8877665544",
  "twitter": "https://twitter.com/Zoho",
  "facebook": "https://www.facebook.com/zoho",
  "telegram": "https://telegram.org/zoho",
  "linkedin": "https://in.linkedin.com/company/zoho",
  "instagram": "https://www.instagram.com/zoho",
  "medium": "https://medium.com/@zoho"
}