NAV
json xml

EventMobi API V1 Spec

Introduction

Version:

1.0.7

Consumes:

application/xml

Produces:

application/xml application/json

Welcome to Eventmobi’s API V1 document!

You can use our API to manage Events, Sessions, Attendees, Speakers, Companies and other data from our Content Management System (CMS).

For any questions or suggestions, please email: api@eventmobi.com.

Endpoint Structure

The API has 3 levels of information:

Event Level

/events/{event_shortcode}

These endpoints provide event information and the list of Event App Sections. Your shortcode can be found from the EventMobi app URL. (eventmobi.com/{event_shortcode})

Section Level

/events/{event_shortcode}/sections/{section_id}

These endpoints provide section details and collection views of items. A section can contain Attendees, Speakers, Sessions, Companies or other types. Each type of section has different properties.

Item Level

events/{event_shortcode}/sections/{section_id}/items/{item_id}.

These endpoints provide details of items within sections. Each item has different properties based on the type of section it belongs to. For example, for an Attendees section, each item is an attendee.

Authorization

X-API-Key='0123456789ABCDEF0123456789ABCDEF

Name In Description
X-API-KEY header String(32). You can request an API key from our support team. (support@eventmobi.com)

Content Type

The request content type supports both multipart/form-data and application/x-www-form-urlencoded. Please note the request example showing in this doc is based on application/x-www-form-urlencoded formatted with new line for each parameter.

The default response content type of responses is application/xml, but you add “.json” at the end of any endpoint to use a application/json response. For example, /events/{event_shortcode}.json

Please choose the “xml” or “json” tabs on the right section to view the response structure.

Errors

In case the API request failed, this error response envelope will be used.

HTTP/1.1 4xx/5xx
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <message>string</message>
    <timestamp>integer</timestamp>
HTTP/1.1 4xx/5xx
Content-Type: application/json

{
    "status": "string",
    "message": "string",
    "timestamp": "integer"
}

Events

GET /events/{event_shortcode}

Get specific event info with sections

GET /en/api/v1/events/{event_shortcode}[.json] HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <id>string</id>
        <event_name>string</event_name>
        <event_description>string</event_description>
        <location_name>string</location_name>
        <location_address>string</location_address>
        <event_website>string</event_website>
        <start_date>string</start_date>
        <end_date>string</end_date>
        <Logo50>string</Logo50>
        <Logo100>string</Logo100>
        <event_name_full>string</event_name_full>
        <support_email_address>string</support_email_address>
        <cache_revision>integer</cache_revision>
        <partner_id>string</partner_id>
        <icon_color>string</icon_color>
        <event_app_name>string</event_app_name>
        <language>string</language>
        <header_images>string</header_images>
        <push_update>string</push_update>
        <pushed_revision>string</pushed_revision>
        <secure_mode>string</secure_mode>
        <login_type>string</login_type>
        <timezone_name>string</timezone_name>
        <timezone_offset_secs>integer</timezone_offset_secs>
        <time_format>string</time_format>
        <banner_ad_display>string</banner_ad_display>
        <force_login_feedback>string</force_login_feedback>
        <restrict_account_reg>string</restrict_account_reg>
        <restrict_profile_edit>string</restrict_profile_edit>
        <passcode>string</passcode>
        <url>string</url>
        <sections>
          <section>
            <id>integer</id>
            <event_id>integer</event_id>
            <name>string</name>
            <type>string</type>
            <icon_class>string</icon_class>
            <color_class>string</color_class>
            <page>string</page>
            <partner_name>string</partner_name>
            <partner_token>string</partner_token>
            <self_edit_from>string</self_edit_from>
            <self_edit_invite>string</self_edit_invite>
            <self_edit_subject>string</self_edit_subject>
            <status>integer</status>
            <position>integer</position>
            <show_ads>boolean</show_ads>
            <url>string</url>
          </section>
        </sections>
        <ads>
          <ad>
            <id>string</id>
            <exhibitor_id>string</exhibitor_id>
            <logo_name>string</logo_name>
            <title>string</title>
            <message>string</message>
            <background_color>string</background_color>
            <sponsorshiplevel>string</sponsorshiplevel>
            <type>string</type>
            <link>string</link>
            <rich>string</rich>
            <call_to_action>string</call_to_action>
            <call_to_action_url>string</call_to_action_url>
            <call_to_action_text>string</call_to_action_text>
            <filename>string</filename>
            <exhibitor_name>string</exhibitor_name>
          </ad>
        </ads>
    </response>
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "string",
    "timestamp": "integer",
    "response": {
        "id": "string",
        "event_name": "string",
        "event_description": "string",
        "location_name": "string",
        "location_address": "string",
        "event_website": "string",
        "start_date": "string",
        "end_date": "string",
        "Logo50": "string",
        "Logo100": "string",
        "event_name_full": "string",
        "support_email_address": "string",
        "cache_revision": "integer",
        "partner_id": "string",
        "icon_color": "string",
        "event_app_name": "string",
        "language": "string",
        "header_images": "string",
        "push_update": "string",
        "pushed_revision": "string",
        "secure_mode": "string",
        "login_type": "string",
        "timezone_name": "string",
        "timezone_offset_secs": "integer",
        "time_format": "string",
        "banner_ad_display": [
            "string"
        ],
        "force_login_feedback": "string",
        "restrict_account_reg": "string",
        "restrict_profile_edit": "string",
        "passcode": "string",
        "url": "string",
        "sections": [
            {
                "id": "integer",
                "event_id": "integer",
                "name": "string",
                "type": "string",
                "icon_class": "string",
                "color_class": "string",
                "page": "string",
                "partner_name": "string",
                "partner_token": "string",
                "self_edit_from": "string",
                "self_edit_invite": "string",
                "self_edit_subject": "string",
                "status": "integer",
                "position": "integer",
                "show_ads": "boolean",
                "url": "string"
            }
        ],
        "ads": [
            {
                "id": "string",
                "exhibitor_id": "string",
                "logo_name": "string",
                "title": "string",
                "message": "string",
                "background_color": "string",
                "sponsorshiplevel": "string",
                "type": "string",
                "link": "string",
                "rich": "string",
                "call_to_action": "string",
                "call_to_action_url": "string",
                "call_to_action_text": "string",
                "filename": "string",
                "exhibitor_name": "string"
            }
        ]
    }
}

This gets the general event information with the full list of sections. The section type indicates which kind of data is stored within that section. Please note the event id is the event shortcode, not a numeric id.

Parameters

Name In Type Description
event_shortcode *  path string Event shortcode.

Responses

Http code Type Description
200 response Event information
404 object Event Not Found

POST /events/{event_shortcode}

Update event information

POST /en/api/v1/events/{event_shortcode}[.json] HTTP/1.1
Content-Type: application/x-www-form-urlencoded

    event_name_full=string&
    event_website=string&
    event_start=string&
    event_end=string"&
    event_location_name=string&
    event_location_address=string&
    event_about=string
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <event>string</event>
    </response>
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "string",
    "timestamp": "integer",
    "response": {
        "event": "string"
    }
}

This is only used to update the basic event information. To change sections or items, please use the sections or items endpoints. Please refer to the EventChangeRequest model definition.

Parameters

Name In Type Description
event_shortcode *  path string Event shortcode
event_request *  body object

Responses

Http code Type Description
200 response Event updated successfully
400 object Bad Request
404 object Event Not Found

Sections

GET /events/{event_shortcode}/sections/{section_id}

Get information about a specific section with the section items

GET /en/api/v1/events/{event_shortcode}/sections/{section_id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <id>integer</id>
        <event_id>integer</event_id>
        <name>string</name>
        <type>string</type>
        <icon_class>string</icon_class>
        <color_class>string</color_class>
        <page>string</page>
        <partner_name>string</partner_name>
        <partner_token>string</partner_token>
        <self_edit_from>string</self_edit_from>
        <self_edit_invite>string</self_edit_invite>
        <self_edit_subject>string</self_edit_subject>
        <status>integer</status>
        <position>integer</position>
        <show_ads>boolean</show_ads>
        <url>string</url>
        <items>
          <item>
            <id>string</id>
            <first_name>string</first_name>
            <about>string</about>
            <image50>string</image50>
            <image100>string</image100>
            <title>string</title>
            <company_name>string</company_name>
            <threetopics>null</threetopics>
            <website>string</website>
            <facebook>string</facebook>
            <twitter>string</twitter>
            <linkedin>string</linkedin>
            <external_id>string</external_id>
            <custom_fields_values>
              <custom_fields_value>
                <type_id>string</type_id>
                <name>string</name>
                <visibility>string</visibility>
                <edit_permissions>string</edit_permissions>
                <section_id>string</section_id>
                <id>string</id>
                <event_id>string</event_id>
                <field_id>string</field_id>
                <value>string</value>
                <owner_type>string</owner_type>
                <owner_id>string</owner_id>
                <deleted>string</deleted>
                <metadata_id>string</metadata_id>
              </custom_fields_value>
            </custom_fields_values>
          </item>
        </items>
        <config>object</config>
        <custom_fields_names>
          <custom_fields_name>
            <id>string</id>
            <event_id>string</event_id>
            <type_id>string</type_id>
            <validation_id>string</validation_id>
            <name>string</name>
            <deleted>string</deleted>
            <section_id>string</section_id>
            <position>string</position>
            <metadata_id>string</metadata_id>
            <visibility>string</visibility>
            <edit_permissions>string</edit_permissions>
            <type_name>string</type_name>
          </custom_fields_name>
        </custom_fields_names>
    </response>
GET /en/api/v1/events/{event_shortcode}/sections/{section_id}.json HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "string",
    "timestamp": "integer",
    "response": {
        "id": "integer",
        "event_id": "integer",
        "name": "string",
        "type": "string",
        "icon_class": "string",
        "color_class": "string",
        "page": "string",
        "partner_name": "string",
        "partner_token": "string",
        "self_edit_from": "string",
        "self_edit_invite": "string",
        "self_edit_subject": "string",
        "status": "integer",
        "position": "integer",
        "show_ads": "boolean",
        "url": "string",
        "items": [
            {
                "id": "string",
                "first_name": "string",
                "about": "string",
                "image50": "string",
                "image100": "string",
                "title": "string",
                "company_name": "string",
                "threetopics": "null",
                "website": "string",
                "facebook": "string",
                "twitter": "string",
                "linkedin": "string",
                "external_id": "string",
                "custom_fields_values": [
                    {
                        "type_id": "string",
                        "name": "string",
                        "visibility": "string",
                        "edit_permissions": "string",
                        "section_id": "string",
                        "id": "string",
                        "event_id": "string",
                        "field_id": "string",
                        "value": "string",
                        "owner_type": "string",
                        "owner_id": "string",
                        "deleted": "string",
                        "metadata_id": "string"
                    }
                ]
            }
        ],
        "config": "object",
        "custom_fields_names": [
            {
                "id": "string",
                "event_id": "string",
                "type_id": "string",
                "validation_id": "string",
                "name": "string",
                "deleted": "string",
                "section_id": "string",
                "position": "string",
                "metadata_id": "string",
                "visibility": "string",
                "edit_permissions": "string",
                "type_name": "string"
            }
        ]
    }
}

This gets the general section information, all items included in that section, and custom fields. Each type of data (Speakers, Attendees, Sessions, etc…) is stored in a different section. The section “type” will indicate what is included in each section.

Parameters

Name In Type Description
event_shortcode *  path string Event Shortcode
section_id *  path string Section ID

Responses

Http code Type Description
200 response Section information
404 object Section Not Found

POST /events/{event_shortcode}/sections/{section_id}

Update section information

POST /en/api/v1/events/{event_shortcode}/sections/{section_id}[.json] HTTP/1.1
Content-Type: application/x-www-form-urlencoded

        name=string&
        position=string&
        type=string
HTTP/1.1 200 OK
Content-Type: application/json

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <event>string</event>
    </response>
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "string",
    "timestamp": "integer",
    "response": {
        "event": "string"
    }
}

This will update settings for a section. Please refer to the SectionChangeRequest model definition.

Parameters

Name In Type Description
event_shortcode *  path string Event shortcode
section_id *  path string Section ID
section_request *  body object

Responses

Http code Type Description
200 response Section updated successfully
400 object Bad Request
404 object Section Not Found

Items

POST /events/{event_shortcode}/sections/{section_id}/items

Add a new item to a section

POST /en/api/v1/events/{event_shortcode}/sections/{section_id}/items HTTP/1.1
Content-Type: application/x-www-form-urlencoded

    topic=string&
    description=string&
    date=string&
    start_time=string&
    end_time=string&
    location=string&
    speakers=string&
    tracks=string&
    attendees=string&
    attendee_name=string&
    attendee_email=string&
    attendee_about=string&
    attendee_topics=string&
    attendee_title=string&
    attendee_company=string&
    attendee_agenda=array&
    website_address=string&
    facebook=string&
    twitter_login=string&
    linkedin_login=string&
    phone=string&
    filename=string&
    custom_fields[custom_field_id]=string&
    external_id=string
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <event>string</event>
    </response>
HTTP/1.1 400 Bad Request
Content-Type: application/xml

{
    "status": "string",
    "message": "string",
    "timestamp": "integer"
}

Add a new item to a section. The item being added most be the same as the section type (Attendees, Speakers, Sessions, etc…). Please refer to the ItemChangeRequest model definition.

Posting the same item again will result duplicated items. If your goal is updating items, please:

Parameters

Name In Type Description
event_shortcode *  path string Event shortcode
section_id *  path string Section ID
new_item *  body object

Responses

Http code Type Description
200 response Item added sucessfully
400 object Bad Request

GET /events/{event_shortcode}/sections/{section_id}/items/{item_id}

Get information for an item

GET /en/api/v1/events/{event_shortcode}/sections/{section_id}/items/{item_id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <id>string</id>
        <first_name>string</first_name>
        <about>string</about>
        <image50>string</image50>
        <image100>string</image100>
        <title>string</title>
        <company_name>string</company_name>
        <attendee_agenda>
            <item>string</item>
        </attendee_agenda>
        <threetopics>null</threetopics>
        <website>string</website>
        <facebook>string</facebook>
        <twitter>string</twitter>
        <linkedin>string</linkedin>
        <external_id>string</external_id>
        <custom_fields_values>
          <custom_fields_value>
            <type_id>string</type_id>
            <name>string</name>
            <visibility>string</visibility>
            <edit_permissions>string</edit_permissions>
            <section_id>string</section_id>
            <id>string</id>
            <event_id>string</event_id>
            <field_id>string</field_id>
            <value>string</value>
            <owner_type>string</owner_type>
            <owner_id>string</owner_id>
            <deleted>string</deleted>
            <metadata_id>string</metadata_id>
          </custom_fields_value>
        </custom_fields_values>
    </response>
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "string",
    "timestamp": "integer",
    "response": {
        "id": "string",
        "first_name": "string",
        "about": "string",
        "image50": "string",
        "image100": "string",
        "title": "string",
        "company_name": "string",
        "attendee_agenda": [ "string" ],
        "threetopics": "null",
        "website": "string",
        "facebook": "string",
        "twitter": "string",
        "linkedin": "string",
        "external_id": "string",
        "custom_fields_values": [
            {
                "type_id": "string",
                "name": "string",
                "visibility": "string",
                "edit_permissions": "string",
                "section_id": "string",
                "id": "string",
                "event_id": "string",
                "field_id": "string",
                "value": "string",
                "owner_type": "string",
                "owner_id": "string",
                "deleted": "string",
                "metadata_id": "string"
            }
        ]
    }
}

Parameters

Name In Type Description
event_shortcode *  path string Event shortcode
section_id *  path string Section ID
item_id *  path string Item ID

Responses

Http code Type Description
200 response Item information
404 object Section/Item Not Found

POST /events/{event_shortcode}/sections/{section_id}/items/{item_id}

Update item info

POST /en/api/v1/events/{event_shortcode}/sections/{section_id}/items/{item_id}[.json] HTTP/1.1
Content-Type: application/x-www-form-urlencoded

    topic=string&
    description=string&
    date=string&
    start_time=string&
    end_time=string&
    location=string&
    speakers=string&
    tracks=string&
    attendees=string&
    attendee_name=string&
    attendee_email=string&
    attendee_about=string&
    attendee_topics=string&
    attendee_title=string&
    attendee_company=string&
    attendee_agenda=array&
    website_address=string&
    facebook=string&
    twitter_login=string&
    linkedin_login=string&
    phone=string&
    filename=string&
    custom_fields[custom_field_id]=string&
    external_id=string
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <event>string</event>
    </response>
HTTP/1.1 400 Bad Request
Content-Type: application/xml

{
    "status": "string",
    "message": "string",
    "timestamp": "integer"
}

Update data for a single item in a section. Please refer to the ItemChangeRequest model definition.

Parameters

Name In Type Description
event_shortcode *  path string Event shortcode
section_id *  path string Section ID
item_id *  path string Item ID
item_request *  body object

Responses

Http code Type Description
200 response Section updated successfully
400 object Bad Request
404 object Not Found

DELETE /events/{event_shortcode}/sections/{section_id}/items/{item_id}

Delete specific item

DELETE /en/api/v1/events/{event_shortcode}/sections/{section_id}/items/{item_id}[.json] HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <event>string</event>
    </response>
HTTP/1.1 400 Bad Request
Content-Type: application/xml

{
    "status": "string",
    "message": "string",
    "timestamp": "integer"
}

Parameters

Name In Type Description
event_shortcode *  path string Event shortcode
section_id *  path string Section ID
item_id *  path string Item ID

Responses

Http code Type Description
200 response Item deleted successfully
400 object Bad Request
404 object Not Found

GET /events/{event_shortcode}/sections/{section_id}/xitems/{external_item_id}

Get an item using an external id

GET /en/api/v1/events/{event_shortcode}/sections/{section_id}/xitems/{external_item_id}[.json] HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <id>string</id>
        <first_name>string</first_name>
        <about>string</about>
        <image50>string</image50>
        <image100>string</image100>
        <title>string</title>
        <company_name>string</company_name>
        <attendee_agenda>
            <item>string</item>
        </attendee_agenda>
        <threetopics>null</threetopics>
        <website>string</website>
        <facebook>string</facebook>
        <twitter>string</twitter>
        <linkedin>string</linkedin>
        <external_id>string</external_id>
        <custom_fields_values>
          <custom_fields_value>
            <type_id>string</type_id>
            <name>string</name>
            <visibility>string</visibility>
            <edit_permissions>string</edit_permissions>
            <section_id>string</section_id>
            <id>string</id>
            <event_id>string</event_id>
            <field_id>string</field_id>
            <value>string</value>
            <owner_type>string</owner_type>
            <owner_id>string</owner_id>
            <deleted>string</deleted>
            <metadata_id>string</metadata_id>
          </custom_fields_value>
        </custom_fields_values>
    </response>
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "string",
    "timestamp": "integer",
    "response": {
        "id": "string",
        "first_name": "string",
        "about": "string",
        "image50": "string",
        "image100": "string",
        "title": "string",
        "company_name": "string",
        "attendee_agenda": [ "string" ],
        "threetopics": "null",
        "website": "string",
        "facebook": "string",
        "twitter": "string",
        "linkedin": "string",
        "external_id": "string",
        "custom_fields_values": [
            {
                "type_id": "string",
                "name": "string",
                "visibility": "string",
                "edit_permissions": "string",
                "section_id": "string",
                "id": "string",
                "event_id": "string",
                "field_id": "string",
                "value": "string",
                "owner_type": "string",
                "owner_id": "string",
                "deleted": "string",
                "metadata_id": "string"
            }
        ]
    }
}

Parameters

Name In Type Description
event_shortcode *  path string Event shortcode
section_id *  path string Section ID
external_item_id *  path string External item ID

Responses

Http code Type Description
200 response Item information
404 object Section/Item Not Found

POST /events/{event_shortcode}/sections/{section_id}/xitems/{external_item_id}

Update item information using an external id

POST /en/api/v1/events/{event_shortcode}/sections/{section_id}/xitems/{external_item_id}[.json] HTTP/1.1
Content-Type: application/x-www-form-urlencoded

    topic=string&
    description=string&
    date=string&
    start_time=string&
    end_time=string&
    location=string&
    speakers=string&
    tracks=string&
    attendees=string&
    attendee_name=string&
    attendee_email=string&
    attendee_about=string&
    attendee_topics=string&
    attendee_title=string&
    attendee_company=string&
    attendee_agenda=array&
    website_address=string&
    facebook=string&
    twitter_login=string&
    linkedin_login=string&
    phone=string&
    filename=string&
    custom_fields[custom_field_id]=string&
    external_id=string
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <event>string</event>
    </response>
HTTP/1.1 400 Bad Request
Content-Type: application/xml

{
    "status": "string",
    "message": "string",
    "timestamp": "integer"
}

Parameters

Name In Type Description
event_shortcode *  path string Event shortcode
section_id *  path string Section ID
external_item_id *  path string External item ID
item_request *  body object

Responses

Http code Type Description
200 response Item updated successfully
400 object Bad Request
404 object Not Found

DELETE /events/{event_shortcode}/sections/{section_id}/xitems/{external_item_id}

Delete an item using an external id

DELETE /en/api/v1/events/{event_shortcode}/sections/{section_id}/xitems/{external_item_id}[.json] HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
    <status>string</status>
    <timestamp>integer</timestamp>
    <response>
        <event>string</event>
    </response>
HTTP/1.1 400 Bad Request
Content-Type: application/xml

{
    "status": "string",
    "message": "string",
    "timestamp": "integer"
}

Parameters

Name In Type Description
event_shortcode *  path string Event shortcode
section_id *  path string Section ID
external_item_id *  path string External item ID

Responses

Http code Type Description
200 response Item deleted successfully
400 object Bad Request
404 object Not Found

Models

Event

{
    "id": "string",
    "event_name": "string",
    "event_description": "string",
    "location_name": "string",
    "location_address": "string",
    "event_website": "string",
    "start_date": "string",
    "end_date": "string",
    "Logo50": "string",
    "Logo100": "string",
    "event_name_full": "string",
    "support_email_address": "string",
    "cache_revision": "integer",
    "partner_id": "string",
    "icon_color": "string",
    "event_app_name": "string",
    "language": "string",
    "header_images": "string",
    "push_update": "string",
    "pushed_revision": "string",
    "secure_mode": "string",
    "login_type": "string",
    "timezone_name": "string",
    "timezone_offset_secs": "integer",
    "time_format": "string",
    "banner_ad_display": [
        "string"
    ],
    "force_login_feedback": "string",
    "restrict_account_reg": "string",
    "restrict_profile_edit": "string",
    "passcode": "string",
    "url": "string",
    "sections": [
        {
            "id": "integer",
            "event_id": "integer",
            "name": "string",
            "type": "string",
            "icon_class": "string",
            "color_class": "string",
            "page": "string",
            "partner_name": "string",
            "partner_token": "string",
            "self_edit_from": "string",
            "self_edit_invite": "string",
            "self_edit_subject": "string",
            "status": "integer",
            "position": "integer",
            "show_ads": "boolean",
            "url": "string"
        }
    ],
    "ads": [
        {
            "id": "string",
            "exhibitor_id": "string",
            "logo_name": "string",
            "title": "string",
            "message": "string",
            "background_color": "string",
            "sponsorshiplevel": "string",
            "type": "string",
            "link": "string",
            "rich": "string",
            "call_to_action": "string",
            "call_to_action_url": "string",
            "call_to_action_text": "string",
            "filename": "string",
            "exhibitor_name": "string"
        }
    ]
}

Event Information

Fields

Name Type Description
id string
event_name string
event_description string
location_name string
location_address string
event_website string
start_date string
end_date string
Logo50 string
Logo100 string
event_name_full string
support_email_address string
cache_revision integer
partner_id string
icon_color string
event_app_name string
language string
header_images string
push_update string
pushed_revision string
secure_mode string
login_type string
timezone_name string
timezone_offset_secs integer
time_format string
banner_ad_display array[string]
force_login_feedback string
restrict_account_reg string
restrict_profile_edit string
passcode string
url string
sections array[object]
ads array[object]

EventSection

{
    "id": "integer",
    "event_id": "integer",
    "name": "string",
    "type": "string",
    "icon_class": "string",
    "color_class": "string",
    "page": "string",
    "partner_name": "string",
    "partner_token": "string",
    "self_edit_from": "string",
    "self_edit_invite": "string",
    "self_edit_subject": "string",
    "status": "integer",
    "position": "integer",
    "show_ads": "boolean",
    "url": "string"
}

Fields

Name Type Description
id integer
event_id integer
name string
type string
icon_class string
color_class string
page string
partner_name string
partner_token string
self_edit_from string
self_edit_invite string
self_edit_subject string
status integer
position integer
show_ads boolean
url string
{
    "id": "string",
    "exhibitor_id": "string",
    "logo_name": "string",
    "title": "string",
    "message": "string",
    "background_color": "string",
    "sponsorshiplevel": "string",
    "type": "string",
    "link": "string",
    "rich": "string",
    "call_to_action": "string",
    "call_to_action_url": "string",
    "call_to_action_text": "string",
    "filename": "string",
    "exhibitor_name": "string"
}

Banner ads

Fields

Name Type Description
id string
exhibitor_id string
logo_name string
title string
message string
background_color string
sponsorshiplevel string
type string
link string
rich string
call_to_action string
call_to_action_url string
call_to_action_text string
filename string
exhibitor_name string

Section

{
    "id": "integer",
    "event_id": "integer",
    "name": "string",
    "type": "string",
    "icon_class": "string",
    "color_class": "string",
    "page": "string",
    "partner_name": "string",
    "partner_token": "string",
    "self_edit_from": "string",
    "self_edit_invite": "string",
    "self_edit_subject": "string",
    "status": "integer",
    "position": "integer",
    "show_ads": "boolean",
    "url": "string",
    "items": [
        {
            "id": "string",
            "first_name": "string",
            "about": "string",
            "image50": "string",
            "image100": "string",
            "title": "string",
            "company_name": "string",
            "threetopics": "null",
            "website": "string",
            "facebook": "string",
            "twitter": "string",
            "linkedin": "string",
            "external_id": "string",
            "custom_fields_values": [
                {
                    "type_id": "string",
                    "name": "string",
                    "visibility": "string",
                    "edit_permissions": "string",
                    "section_id": "string",
                    "id": "string",
                    "event_id": "string",
                    "field_id": "string",
                    "value": "string",
                    "owner_type": "string",
                    "owner_id": "string",
                    "deleted": "string",
                    "metadata_id": "string"
                }
            ]
        }
    ],
    "config": "object",
    "custom_fields_names": [
        {
            "id": "string",
            "event_id": "string",
            "type_id": "string",
            "validation_id": "string",
            "name": "string",
            "deleted": "string",
            "section_id": "string",
            "position": "string",
            "metadata_id": "string",
            "visibility": "string",
            "edit_permissions": "string",
            "type_name": "string"
        }
    ]
}

These items are only returned as part of the section GET request, not in the event GET request.

Fields

Name Type Description
id integer
event_id integer
name string
type string
icon_class string
color_class string
page string
partner_name string
partner_token string
self_edit_from string
self_edit_invite string
self_edit_subject string
status integer
position integer
show_ads boolean
url string
items array[object]
config object the config meta object with properties
custom_fields_names array[object]

Item

{
    "id": "string",
    "first_name": "string",
    "about": "string",
    "image50": "string",
    "image100": "string",
    "title": "string",
    "company_name": "string",
    "attendee_agenda": [ "string" ],
    "threetopics": "null",
    "website": "string",
    "facebook": "string",
    "twitter": "string",
    "linkedin": "string",
    "external_id": "string",
    "custom_fields_values": [
        {
            "type_id": "string",
            "name": "string",
            "visibility": "string",
            "edit_permissions": "string",
            "section_id": "string",
            "id": "string",
            "event_id": "string",
            "field_id": "string",
            "value": "string",
            "owner_type": "string",
            "owner_id": "string",
            "deleted": "string",
            "metadata_id": "string"
        }
    ]
}

Fields

Name Type Description
id string
first_name string
about string
image50 string
image100 string
title string
company_name string
attendee_agenda array[string]
threetopics null
website string
facebook string
twitter string
linkedin string
external_id string
custom_fields_values array[object]

CustomFieldName

{
    "id": "string",
    "event_id": "string",
    "type_id": "string",
    "validation_id": "string",
    "name": "string",
    "deleted": "string",
    "section_id": "string",
    "position": "string",
    "metadata_id": "string",
    "visibility": "string",
    "edit_permissions": "string",
    "type_name": "string"
}

Fields

Name Type Description
id string
event_id string
type_id string
validation_id string
name string
deleted string
section_id string
position string
metadata_id string
visibility string
edit_permissions string
type_name string

CustomFieldValue

{
    "type_id": "string",
    "name": "string",
    "visibility": "string",
    "edit_permissions": "string",
    "section_id": "string",
    "id": "string",
    "event_id": "string",
    "field_id": "string",
    "value": "string",
    "owner_type": "string",
    "owner_id": "string",
    "deleted": "string",
    "metadata_id": "string"
}

Fields

Name Type Description
type_id string
name string
visibility string
edit_permissions string
section_id string
id string
event_id string
field_id string
value string
owner_type string
owner_id string
deleted string
metadata_id string

EventChangeRequest

{
    "event_name_full": "string",
    "event_website": "string",
    "event_start": "string",
    "event_end": "string",
    "event_location_name": "string",
    "event_location_address": "string",
    "event_about": "string"
}

Update event information

Fields

Name Type Description
event_name_full *  string Name of the event. Must be included but can be updated.
event_website string Event website URL
event_start *  string Start date (required, yyyy-mm-dd)
event_end *  string End date (required, yyyy-mm-dd)
event_location_name string Event location name
event_location_address string Event location address
event_about string Description of event

SectionChangeRequest

{
    "name": "string",
    "position": "string",
    "type": "string"
}

Update section information

Fields

Name Type Description
name *  string Name of section (required)
position *  string Position of section in the section list (required)
type *  string Type of section (One of agenda, speakers, companies, attendees)(required)

ItemChangeRequest

{
    "topic": "string",
    "description": "string",
    "date": "string",
    "start_time": "string",
    "end_time": "string",
    "location": "string",
    "speakers": "string",
    "tracks": "string",
    "attendees": "string",
    "attendee_name": "string",
    "attendee_email": "string",
    "attendee_about": "string",
    "attendee_topics": "string",
    "attendee_title": "string",
    "attendee_company": "string",
    "attendee_agenda": ["string"],
    "website_address": "string",
    "facebook": "string",
    "twitter_login": "string",
    "linkedin_login": "string",
    "filename": "string",
    "custom_fields[custom_field_id]": "string",
    "external_id": "string"
}

Please use different properties for different section types. Currently, only sessions and attendees are supported.

Fields

Name Type Description
topic string Session: title of session (required)
description string Session: description of session (required)
date string Session: date of session (required)
start_time string Session: start time of session (required)
end_time string Session: end time of session
location string Session: location of session
speakers string Session: comma separated list of speakers by external id’s
tracks string Session: comma separated list of tracks by external id’s
attendees string Session: comma separated list of attendees by emails
attendee_name string Attendee: name of attendee (required)
attendee_email string Attendee: email address (required)
attendee_about string Attendee: attendee bio
attendee_title string Attendee: title
attendee_company string Attendee: company employed at
attendee_agenda array Attendee: the session ID string array for personal agenda once user login the app. External ID are supported if sessions are created with ID from foreign system. Email is required to support this function or it will be ignored. The ids in array need to have quote marks e.g. [“123”, “456”].
website_address string Attendee: attendee website
facebook string Attendee: Facebook
twitter_login string Attendee: Twitter name
linkedin_login string Attendee: LinkedIn name
filename string Attendee: name of previously uploaded image file
custom_fields[custom_field_id] string Attendee: value for this custom field. Once you have the Custom Field settings from section request, you can use the id within to assign values, E.g. custom_fields[40211]: “Custom Field Value”. You may have multiple custom fields included.
external_id string Shared: your code for representing this item

SuccessEnvolope

{
    "status": "string",
    "timestamp": "integer"
}

The general envelope for all responses. The “response” section will be different for each endpoint

Fields

Name Type Description
status string Success or error
timestamp integer Timestamp of the response

ErrorEnvolope

{
    "status": "string",
    "message": "string",
    "timestamp": "integer"
}

Fields

Name Type Description
status string Will be “error”
message string The error message will be included here
timestamp integer The timestamp when the error occurred