Partner API Version 3

Status

Last revised .

This document describes version 'v3'.

Conventions

In a URL, any piece starting with a colon (":example") is a variable that would be replaced by an actual value.

In a JSON snippet, any uppercase key is a variable that would be replaced by an actual key.

Universal Request Requirements

All requests must be over HTTPS.

All requests must have an Access-Token header (see Authentication). All requests should also have an Accept header with the value "application/json".

All PUT and POST requests must have a Content-Type header with the value "application/json".

Each field provided in an object (e.g., a track or person) may only appear once in that object. In the case that duplicate keys are provided, the last one will be used.

Universal Response Requirements

All responses will be of the JSON Content-Type.

All responses are private to caches, using the Pragma "no-cache" and Cache-Control "private" headers.

API Base

The base URL is:

https://api.crowdcompass.com/:version

Resource Identification

This is a resource-oriented API. Collections of resources and individual resources are indicated by directing the request to a specific URL. For example, referencing the activity with OID "ActActActA" in the event with OID "OidOidOidO" is done with the following URL:

https://api.crowdcompass.com/v3/events/OidOidOidO/activities/ActActActA

Verbs referring to a single resource (GET, PUT, DELETE) are directed at this URL. To address the entire set of activities for the event, you would use:

https://api.crowdcompass.com/v3/events/OidOidOidO/activities

This URL would accept verbs referring to a collection of resources (GET, POST).

OIDs are case-sensitive and consist of ten alphanumeric characters.

Resource Verbs

The following HTTP verbs have a defined meaning in this API when directed at a resource or collection of resources. Some resources do not support every verb, and some special URLs are available that do not directly correspond to resources. These are indicated in the documentation for the API.

GET

The GET verb, when directed at an individual resource, is a request for the complete details about that resource. The response has the following structure:

{
  "PLURAL_RESOURCE_TYPE":
  [
    { ... RESOURCE ... }
  ]
}

Although the response contains an array, this array will always contain a single value.

When directed at a collection of resources, GET is a request for a listing or summary of those resources. The response has the following structure:

{
  "PLURAL_RESOURCE_TYPE":
  [
    { ... RESOURCE ... },
      ...
  ],
  "pagination": {
    ... PAGINATION ...
  }
}

The array will contain zero or more resources.

Please see Pagination for the structure of the pagination object.

The only error responses possible for GET are global errors (400, 403, 404, 500). See Success/Error Codes for more information.

POST

The POST verb is directed at a collection of resources and attempts to create a new resource.

Creating records in bulk is not currently supported. If multiple records are submitted in a single request, only the first record will be created.

The request body has the following structure:

{
  "PLURAL_RESOURCE_TYPE":
  [
    { ... RESOURCE ... }
  ]
}

When successful, the response is a 201 and the body has the same structure.

When unsuccessful, the response is a 422 and the body will contain the key "error". The value of the key will differ depending on the type of error.

  • If the error is a structural one (the resource being omitted entirely, extra keys being included, etc.) the value of "error" will be a string describing the problem.
  • If the error is in data validation (required values omitted, unique values duplicated, content of a field being incorrect) the value of "error" will be an object of the following format:
{
  "FIELD1": [ "PROBLEM", ... ],
  "FIELD2": [ ... ],
  ...
}

PUT

The PUT verb is directed at an individual resource and attempts to update an existing resource. The request body is the same as for a POST.

Updating records in bulk is not currently supported. If multiple records are submitted in a single request, only the first record will be updated.

When using PUT to delete a resource, use a value of "" or empty string. Updating with a null value is considered the same as omitting the field.

When successful, the response is a 200 and the body has the same structure.

When unsuccessful, the response is a 422 of the same type as returned for a POST.

DELETE

The DELETE verb is directed at an individual resource and attempts to delete an existing resource. The request body must be empty.

When successful, the response is a 204 with an empty body.

The only error responses possible for DELETE are global errors (400, 403, 404, 500). See Success/Error Codes for more information.

Common Resource Attributes

All resources have an "oid" attribute on creation. This cannot be set during creation or changed afterwards; it is always provided by the system.

API clients may provide a "ref" attribute when creating a resource. This may be any string value but must be unique for that resource type and event.

Response Codes

The API uses standard HTTP status codes to specify conditions, along with a descriptive JSON body. Reference the HTTP 1.1 RFC for details on how a client is supposed to respond to each code.

Success Codes

200 OK
A successful response for a GET or PUT. Body is the requested data.
201 Created
A successful response for a POST. Body is the newly created entity.
204 No Content
A successful response for a DELETE. Body is empty.

Error Codes

Error responses will have a single _error_ member in the JSON response providing more detail about the error.

Authentication and resource lookup will always be performed, so any request can receive a 403 or 404 error before any of the error behavior described in *Resource Verbs*.

400 Bad Request
An error response given if the request could not be processed due to being malformed or unprocessable.
403 Forbidden
An error response given if an Access-Token was not provided, is invalid, or the user does not have access to perform the operation.
404 Not Found
An error response given if the resource indicated in the URL does not exist.
422 Unprocessable Entity
An error response given if the content of a POST or PUT has an invalid structure or invalid field contents.
500 Internal Server Error
An error response given if the server has an unexpected exception while processing a request.
Authentication

All API requests must be authenticated. Authentication is provided by passing an Access-Token header. Each user with API access has a single unique Access-Token.

The following rules apply to all API calls:

  • If the Access-Token header is omitted, the response will be a *403* and the body will indicate that the header was missing.
    { "error": "Access denied: access token missing" }
  • If the Access-Token cannot be found for any user or if the user does not have access to perform the requested action, the response will be a 403 and the body will indicate that the user is not authorized.
    { "error": "Either the given event EventOid11 does not exist or you do not have access to it." }
  • If the Access-Token is found, and the user has access to perform the requested action, authentication will succeed and the response will be handled.
Pagination

Most GET requests directed to a collection are paginated. The pagination object will always be indicated with the key "pagination" and will contain the following members:

returned_records
The number of records actually returned in this response.
total
The total number of records that are accessible by paginating over this resource collection.
offset
The current position in the paginated collection that the returned records start from, indexed from 0.
limit
The number of records requested. This defaults to 100, which is the maximum value. A lower limit may be set.
next
The URL at which the next page of resources can be accessed.
Available Resources

All URLs follow the base URL https://api.crowdcompass.com/v3.

User Agent

You may provide a User-Agent header with requests. This header can be used to identify requests coming from a specific client implementation of the API. This header is used strictly for reference and does not need to follow a particular format.

Invitations
Resource Plural
invitations
Collection
/events/:event_oid/invitations (supports standard GET, POST)
Resource
/events/:event_oid/invitations/:id (supports standard GET, DELETE, PUT)

Invitations can be referenced by two identifiers: external reference, or oid. The external reference is an identifier that originates from the consumer of the API when creating records. CrowdCompass automatically generates an oid (object id) for each record created in our system. Using email as the identifier will continue to work but is deprecated. Results will only be accurate if the email is unique to the event. Please use external references or CrowdCompass provided oids as identifiers.

Resource attributes

The following attributes are supported for POST:

Attribute Type Description
email string Email is required for attendee registration and login, but can be hidden from an attendee’s profile if “show_email_in_profile” is set to false.
first_name string
last_name string
suffix string
job_title string
organization_name string
bio string
address_street_1 string
address_street_2 string
address_city string
address_state string
address_zipcode string
address_country string
phone_work string
phone_mobile string
phone_other string
phone_other_type string
website string If the field does not include an "http://" or "https://" prefix in POST requests, the prefix "http://" will be prepended automatically.
website_2 string If the field does not include an "http://" or "https://" prefix in POST requests, the prefix "http://" will be prepended automatically.
linkedin_url string If the field does not include an "http://" or "https://" prefix in POST requests, the prefix "http://" will be prepended automatically.
twitter_url string If the field does not include an "http://" or "https://" prefix in POST requests, the prefix "http://" will be prepended automatically.
facebook_url string If the field does not include an "http://" or "https://" prefix in POST requests, the prefix "http://" will be prepended automatically.
registration_code string Registration Codes are not required, but will be auto-generated as a reference ID if not provided.
show_email_in_profile boolean optional - defaults to true if left blank
is_moderator boolean Live Q&A Moderator status is optional - defaults to false if left blank
visible_on_attendee_list boolean optional - defaults to false if left blank
group_list array of strings deprecated - please use "groups" instead
groups array optional - an array of group object refs or oids
custom_fields array optional - an array of custom fields definition oids and values
ref string
remote_avatar_url string
source string integration name (please contact CrowdCompass to enable this feature)
source_url string integration URL (please contact CrowdCompass to enable this feature)

The following attributes are internally managed and must not be included with POST but will be returned with GET:

Attribute Type Description
oid string
status string
delivery_requested boolean
delivered_at string/timestamp
ident string Unique ID for this invitee required by some other APIs
updated_at string/timestamp
created_at string/timestamp
groups array a group's `source` can not be included in a post request
Show Invitation
GET
https://api.crowdcompass.com/v3/events/GdxFpdzfrf/invitations/LCS7CCCHcU
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 1202
{
  "invitations": {
    "created_at": "2018-08-13T17:33:14Z",
    "updated_at": "2018-08-13T17:33:14Z",
    "email": "john@example.com",
    "first_name": "EDDY",
    "last_name": "Chimpden",
    "suffix": "MD",
    "status": "ready to deliver",
    "delivery_requested": false,
    "delivery_requested_at": "",
    "registration_code": "R3gC0de",
    "oid": "LCS7CCCHcU",
    "ref": "invitation_ref",
    "source": "",
    "source_url": "",
    "job_title": "Analyst #7",
    "organization_name": "ZZZ Corp",
    "bio": "The foremost expert in analysis",
    "address_street_1": "1234 Evergreen Terrace",
    "address_street_2": "Suite 300",
    "address_city": "Portland",
    "address_state": "OR",
    "address_zipcode": "97206",
    "address_country": "US",
    "phone_work": "555-555-5555",
    "phone_mobile": "555-555-5556",
    "website": "http://example.com",
    "website_2": "",
    "linkedin_url": "https://linkedin.com/pub/crowdcompass",
    "twitter_url": "https://twitter.com/crowdcompass",
    "facebook_url": "https://facebook.com/crowdcompass",
    "show_email_in_profile": true,
    "visible_on_attendee_list": true,
    "phone_other_type": "",
    "phone_other": "",
    "is_moderator": false,
    "group_list": [

    ],
    "groups": [

    ],
    "delivered_at": "",
    "custom_fields": [

    ],
    "remote_avatar_url": "https://accounts.crowdcompass.com/assets/user-profiles/avatar.png",
    "ident": "73f0601a-4305-4315-8f9b-864ac184bc5b"
  }
}
List Invitations
GET
https://api.crowdcompass.com/v3/events/GdxFpdzfrf/invitations
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 1257
{
  "invitations": [
    {
      "created_at": "2018-08-13T17:33:14Z",
      "updated_at": "2018-08-13T17:33:14Z",
      "email": "john@example.com",
      "first_name": "EDDY",
      "last_name": "Chimpden",
      "suffix": "MD",
      "status": "ready to deliver",
      "delivery_requested": false,
      "delivery_requested_at": "",
      "registration_code": "R3gC0de",
      "oid": "LCS7CCCHcU",
      "ref": "invitation_ref",
      "source": "",
      "source_url": "",
      "job_title": "Analyst #7",
      "organization_name": "ZZZ Corp",
      "bio": "The foremost expert in analysis",
      "address_street_1": "1234 Evergreen Terrace",
      "address_street_2": "Suite 300",
      "address_city": "Portland",
      "address_state": "OR",
      "address_zipcode": "97206",
      "address_country": "US",
      "phone_work": "555-555-5555",
      "phone_mobile": "555-555-5556",
      "website": "http://example.com",
      "website_2": "",
      "linkedin_url": "https://linkedin.com/pub/crowdcompass",
      "twitter_url": "https://twitter.com/crowdcompass",
      "facebook_url": "https://facebook.com/crowdcompass",
      "show_email_in_profile": true,
      "visible_on_attendee_list": true,
      "phone_other_type": "",
      "phone_other": "",
      "is_moderator": false,
      "delivered_at": "",
      "custom_fields": [

      ],
      "remote_avatar_url": "https://accounts.crowdcompass.com/assets/user-profiles/avatar.png",
      "ident": "73f0601a-4305-4315-8f9b-864ac184bc5b"
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Create Invitation
POST
https://api.crowdcompass.com/v3/events/GdxFpdzfrf/invitations
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "invitations": [
    {
      "ref": "invitation_ref",
      "email": "john@example.com",
      "first_name": "EDDY",
      "last_name": "Chimpden",
      "suffix": "MD",
      "job_title": "Analyst #7",
      "organization_name": "ZZZ Corp",
      "bio": "The foremost expert in analysis",
      "address_street_1": "1234 Evergreen Terrace",
      "address_street_2": "Suite 300",
      "address_city": "Portland",
      "address_state": "OR",
      "address_zipcode": "97206",
      "address_country": "US",
      "phone_work": "555-555-5555",
      "phone_mobile": "555-555-5556",
      "website": "http://example.com",
      "linkedin_url": "https://linkedin.com/pub/crowdcompass",
      "twitter_url": "https://twitter.com/crowdcompass",
      "facebook_url": "https://facebook.com/crowdcompass",
      "show_email_in_profile": true,
      "visible_on_attendee_list": true,
      "is_moderator": false,
      "registration_code": "R3gC0de",
      "remote_avatar_url": "https://accounts.crowdcompass.com/assets/user-profiles/avatar.png"
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 1204
{
  "invitations": [
    {
      "created_at": "2018-08-13T17:33:14Z",
      "updated_at": "2018-08-13T17:33:14Z",
      "email": "john@example.com",
      "first_name": "EDDY",
      "last_name": "Chimpden",
      "suffix": "MD",
      "status": "ready to deliver",
      "delivery_requested": false,
      "delivery_requested_at": "",
      "registration_code": "R3gC0de",
      "oid": "LCS7CCCHcU",
      "ref": "invitation_ref",
      "source": "",
      "source_url": "",
      "job_title": "Analyst #7",
      "organization_name": "ZZZ Corp",
      "bio": "The foremost expert in analysis",
      "address_street_1": "1234 Evergreen Terrace",
      "address_street_2": "Suite 300",
      "address_city": "Portland",
      "address_state": "OR",
      "address_zipcode": "97206",
      "address_country": "US",
      "phone_work": "555-555-5555",
      "phone_mobile": "555-555-5556",
      "website": "http://example.com",
      "website_2": "",
      "linkedin_url": "https://linkedin.com/pub/crowdcompass",
      "twitter_url": "https://twitter.com/crowdcompass",
      "facebook_url": "https://facebook.com/crowdcompass",
      "show_email_in_profile": true,
      "visible_on_attendee_list": true,
      "phone_other_type": "",
      "phone_other": "",
      "is_moderator": false,
      "group_list": [

      ],
      "groups": [

      ],
      "delivered_at": "",
      "custom_fields": [

      ],
      "remote_avatar_url": "https://accounts.crowdcompass.com/assets/user-profiles/avatar.png",
      "ident": "73f0601a-4305-4315-8f9b-864ac184bc5b"
    }
  ]
}
Update Existing Invitation
PUT
https://api.crowdcompass.com/v3/events/GdxFpdzfrf/invitations/LCS7CCCHcU
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "invitations": [
    {
      "first_name": "YDDE",
      "last_name": "nedpmihC",
      "groups": [
        {
          "oid": "1xhp7xZmok"
        },
        {
          "ref": "my-group-1"
        }
      ]
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 1364
{
  "invitations": [
    {
      "created_at": "2018-08-13T17:33:14Z",
      "updated_at": "2018-08-13T17:33:14Z",
      "email": "john@example.com",
      "first_name": "YDDE",
      "last_name": "nedpmihC",
      "suffix": "MD",
      "status": "ready to deliver",
      "delivery_requested": false,
      "delivery_requested_at": "",
      "registration_code": "R3gC0de",
      "oid": "LCS7CCCHcU",
      "ref": "invitation_ref",
      "source": "",
      "source_url": "",
      "job_title": "Analyst #7",
      "organization_name": "ZZZ Corp",
      "bio": "The foremost expert in analysis",
      "address_street_1": "1234 Evergreen Terrace",
      "address_street_2": "Suite 300",
      "address_city": "Portland",
      "address_state": "OR",
      "address_zipcode": "97206",
      "address_country": "US",
      "phone_work": "555-555-5555",
      "phone_mobile": "555-555-5556",
      "website": "http://example.com",
      "website_2": "",
      "linkedin_url": "https://linkedin.com/pub/crowdcompass",
      "twitter_url": "https://twitter.com/crowdcompass",
      "facebook_url": "https://facebook.com/crowdcompass",
      "show_email_in_profile": true,
      "visible_on_attendee_list": true,
      "phone_other_type": "",
      "phone_other": "",
      "is_moderator": false,
      "group_list": [
        "Group A",
        "Group B"
      ],
      "groups": [
        {
          "name": "Group A",
          "oid": "1xhp7xZmok",
          "ref": "1xhp7xZmok",
          "source": null
        },
        {
          "name": "Group B",
          "oid": "7VeisUbP1M",
          "ref": "my-group-1",
          "source": null
        }
      ],
      "delivered_at": "",
      "custom_fields": [

      ],
      "remote_avatar_url": "https://accounts.crowdcompass.com/assets/user-profiles/avatar.png",
      "ident": "73f0601a-4305-4315-8f9b-864ac184bc5b"
    }
  ]
}
Delete Existing Invitation
DELETE
https://api.crowdcompass.com/v3/events/GdxFpdzfrf/invitations/LCS7CCCHcU
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Events
Resource Plural
events
Collection
events (supports GET)
Resource
events/:event_oid (supports GET)

A GET request to the events endpoint returns a paginated list of all events accessible by the provided token. A GET request to the events/:event_oid endpoint returns details of the requested event.

List events

Get a list of events

GET
https://api.crowdcompass.com/v3/events/MRg3aAHmMU
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 18
{
  "events": [
    {
      "oid": "WAKKAWAKKA",
      "name": "HereConf",
      "start_date": "2017-08-04 00:56",
      "end_date": "2017-08-04 00:56"
    }
  ]
}
Show event

Fetch details of a single event

GET
https://api.crowdcompass.com/v3/events/MRg3aAHmMU
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 18
{
  "events": [
    {
      "oid": "WAKKAWAKKA",
      "name": "HereConf",
      "start_date": "2017-08-04 00:56",
      "end_date": "2017-08-04 00:56",
      "time_zone": "America/Los_Angeles",
      "event_code": "shortcode",
      "marketing": {
        "app_download_url": "https://crowd.cc/s/1VLu",
        "event_short_url": "https://crowd.cc/acpfeb2014",
        "event_url": "https://event.crowdcompass.com/shortcode",
        "qr_codes": {
          "small": "https://crowd.cc/acpfeb2014.png?size=small",
          "medium": "https://crowd.cc/acpfeb2014.png?size=medium",
          "large": "https://crowd.cc/acpfeb2014.png?size=large"
        }
      }
    }
  ]
}
Ping an event

Ping an event. See what happens.

GET
https://api.crowdcompass.com/v3/events/MRg3aAHmMU/ping
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 18
{
  "message": "pong"
}
Assets
Resource Plural
assets
Collection
/events/:event_oid/assets (supports POST)
Resource
/events/:event_oid/assets/:oid (supports GET)
Attribute Type Description
url string The publicly-accessible location of the asset source data. Max size: 10MB.
asset_type string one of IMAGE_MAIN, IMAGE_DETAIL, or DOCUMENT.
ref string used as an external identifier *

* ref is used for relating documents to 3rd party identifiers used outside of CrowdCompass's own internal identifiers and cannot exceed 64 characters.

Create Asset
POST
https://api.crowdcompass.com/v3/events/7Maw61Kpvr/assets
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "assets": [
    {
      "url": "https://example.com/source.jpg",
      "asset_type": "IMAGE_MAIN",
      "ref": "external-id"
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 332
{
  "assets": [
    {
      "oid": "mCJm3uNig0",
      "ref": "external-id",
      "created_at": "2018-08-13T17:33:14Z",
      "updated_at": "2018-08-13T17:33:14Z",
      "name": "",
      "attachable_type": "",
      "attachable_oid": "",
      "attachable_ref": "",
      "url": "https://example.com/source.jpg",
      "asset_type": "IMAGE_MAIN",
      "asset_url": "",
      "processing_errors": "",
      "processing_status": "processing"
    }
  ]
}
Show Asset
GET
https://api.crowdcompass.com/v3/events/7Maw61Kpvr/assets/mCJm3uNig0
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 434
{
  "assets": [
    {
      "oid": "mCJm3uNig0",
      "ref": "external-id",
      "created_at": "2018-08-13T17:33:14Z",
      "updated_at": "2018-08-13T17:33:14Z",
      "name": "",
      "attachable_type": "",
      "attachable_oid": "",
      "attachable_ref": "",
      "url": "https://example.com/source.jpg",
      "asset_type": "IMAGE_MAIN",
      "asset_url": "",
      "processing_errors": "Data file size must be greater than 0 Bytes, Data must be greater than 0 Bytes, Asset type must be an image",
      "processing_status": "error"
    }
  ]
}
Schedule changes
Resource Plural
schedule_changes
Collection
/events/:event_oid/schedule_changes (supports standard POST; supports modified GET, see below)
Resource
N/A; schedule changes cannot be address individually

Resource attributes

The following attributes are supported for POST:

Attribute Type Description
attendee_ref string The ref of a previously created invitation. attendee_ref must be provided
activity_oid/activity_ref string/oid or string/ref One is required
action string "add" or "drop" (optional, defaults to "add" if omitted)

The following attributes are internally managed and must not be included with POST but will be returned with GET:

Attribute Type Description
status string "unsent" or "applied" or "missing" or "error"

Custom Collection GET

The GET for the schedule_changes collection returns a summary of results instead of a paginated index. It has the following format:

GET
https://api.crowdcompass.com/v3/events/ua02iP0sqw/schedule_changes
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 46
{
  "unsent": 1,
  "applied": 0,
  "missing": 0,
  "error": 0
}
Create schedule change
Attribute Type Description
attendee_ref string required
activity_oid oid string required
timestamp time string show time format
action string Either "add" or "drop
POST
https://api.crowdcompass.com/v3/events/ua02iP0sqw/schedule_changes
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "schedule_changes": [
    {
      "activity_oid": "ACTIVITYOI",
      "timestamp": "2018-08-13 17:33:15 +0000",
      "action": "add",
      "activity_ref": "activity-ref659",
      "attendee_ref": "external-ref-47"
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 199
{
  "schedule_changes": [
    {
      "email": null,
      "activity_oid": "9xgKcko9ob",
      "activity_ref": "activity-ref659",
      "action": "add",
      "status": "unsent",
      "attendee_ref": "external-ref-47",
      "timestamp": "2018-08-13T17:33:15Z"
    }
  ]
}
Show schedule change status

Schedule change states:

  • unsent
  • applied
  • missing
  • error

Get a schedule changes where state is unsent:

GET
https://api.crowdcompass.com/v3/events/ua02iP0sqw/schedule_changes/unsent
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 280
{
  "schedule_changes": [
    {
      "email": null,
      "activity_oid": "9xgKcko9ob",
      "activity_ref": "activity-ref659",
      "action": "add",
      "status": "unsent",
      "attendee_ref": "external-ref-47",
      "timestamp": "2018-08-13T17:33:15Z"
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Activities
Resource Plural
activities
Collection
/events/:event_oid/activities (supports standard GET, POST)
Resource
/events/:event_oid/activities/:oid (supports standard GET, PUT, DELETE)
Attribute Type Description
name string
description string
source string integration name (please contact CrowdCompass to enable this feature)
source_url string integration URL (please contact CrowdCompass to enable this feature)
start_datetime string/timestamp relative to the event timezone (required)
end_datetime string/timestamp relative to the event timezone (required)
tags array of strings
track_ref or track_oid reference to associated track
parent_activity object see Parent Activity
subsessions array of objects see Subsessions
related_activities array of objects see Related Activity
presenters array of objects see Presenters
entity_policies array of objects see Entity Policies
activity_code string
location_name string
has_live_qa boolean
assets array optional - an array of asset object refs or oids **
groups array optional - an array of group object refs or oids

** assets must be uploaded to CrowdCompass using the Create Asset endpoint before they can be referenced.

Parent Activity

Providing a parent activity will create a subsession for the given parent.
Providing a parent activity with the ref missing or blank will remove the parent activity.

Attribute Type Description
ref the ref of the parent activity

Subsessions

The refs of the activities that are subsessions of the requested activity.
To remove a subsession you must supply parent activity with a missing or blank ref.

Attribute Type Description
ref the ref provided for the subsession

Related Activity

Attribute Type Description
ref the ref provided for another activity

Presenters

Attribute Type Description
person_ref the ref of the person associated with the activity
person_oid 10 character unique identifier used by CrowdCompass. Do not send this attribute in any requests.
role the role the person at the activity (i.e. "Speaker")

Entity Policies

Include this attribute to apply an entity policy (session rule) to an activity

Attribute Type Description
ref the ref of the entity policy associated with the activity
List Activities
GET
https://api.crowdcompass.com/v3/events/PQxSGBtysj/activities
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 2259
{
  "activities": [
    {
      "ref": "activity-ref660",
      "oid": "3OacgZ9EH1",
      "source": null,
      "source_url": null,
      "created_at": "2018-08-13T17:33:15Z",
      "updated_at": "2018-08-13T17:33:15Z",
      "name": "Keynote",
      "start_datetime": "2010-05-02 14:00:00",
      "end_datetime": "2010-05-02 16:00:00",
      "related_activities": [

      ],
      "activity_code": "",
      "location_name": "",
      "track_ref": "",
      "track_oid": "",
      "presenters": [

      ],
      "parent_activity": {
      },
      "subsessions": [
        {
          "ref": "fnrl4timf"
        }
      ],
      "assets": [

      ],
      "description": "You want to get excited about something that is super cool? Well don't miss this.",
      "tags": [

      ],
      "has_live_qa": false,
      "groups": [

      ],
      "entity_policies": [

      ],
      "session_state": "open",
      "capacity_type": "unlimited"
    },
    {
      "ref": "activity-ref661",
      "oid": "20N6YOI4Vq",
      "source": null,
      "source_url": null,
      "created_at": "2018-08-13T17:33:15Z",
      "updated_at": "2018-08-13T17:33:15Z",
      "name": "Keynote",
      "start_datetime": "2010-05-02 14:00:00",
      "end_datetime": "2010-05-02 16:00:00",
      "related_activities": [

      ],
      "activity_code": "",
      "location_name": "",
      "track_ref": "",
      "track_oid": "",
      "presenters": [

      ],
      "parent_activity": {
      },
      "subsessions": [

      ],
      "assets": [

      ],
      "description": "You want to get excited about something that is super cool? Well don't miss this.",
      "tags": [

      ],
      "has_live_qa": false,
      "groups": [

      ],
      "entity_policies": [

      ],
      "session_state": "open",
      "capacity_type": "unlimited"
    },
    {
      "ref": "fnrl4timf",
      "oid": "HT8c7E2BtZ",
      "source": null,
      "source_url": null,
      "created_at": "2018-08-13T17:33:15Z",
      "updated_at": "2018-08-13T17:33:15Z",
      "name": "Funeral for Tim Finnegan",
      "start_datetime": "2018-08-13 17:33:00",
      "end_datetime": "2018-08-13 18:33:00",
      "related_activities": [
        {
          "oid": "3OacgZ9EH1",
          "ref": "activity-ref660"
        },
        {
          "oid": "20N6YOI4Vq",
          "ref": "activity-ref661"
        }
      ],
      "activity_code": "",
      "location_name": "",
      "track_ref": "WAKKAWAKKA",
      "track_oid": "e7NC2SSKPE",
      "presenters": [
        {
          "oid": "PzRZGiyTfm",
          "person_oid": "ukNJBwwoZy",
          "person_ref": "ukNJBwwoZy",
          "role": "MC",
          "created_at": "2018-08-13T17:33:15Z",
          "updated_at": "2018-08-13T17:33:15Z"
        }
      ],
      "parent_activity": {
        "ref": "activity-ref660"
      },
      "subsessions": [

      ],
      "assets": [

      ],
      "description": "A funeral and wake for Tim Finnegan who fell",
      "tags": [
        "funeral",
        "wake"
      ],
      "has_live_qa": true,
      "groups": [

      ],
      "entity_policies": [
        {
          "oid": "YleZWvNMgd",
          "ref": "YleZWvNMgd"
        }
      ],
      "session_state": null,
      "capacity_type": null
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 3,
    "total": 3
  }
}
Show Activity
GET
https://api.crowdcompass.com/v3/events/PQxSGBtysj/activities/HT8c7E2BtZ
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 935
{
  "activities": [
    {
      "ref": "fnrl4timf",
      "oid": "HT8c7E2BtZ",
      "source": null,
      "source_url": null,
      "created_at": "2018-08-13T17:33:15Z",
      "updated_at": "2018-08-13T17:33:15Z",
      "name": "Funeral for Tim Finnegan",
      "start_datetime": "2018-08-13 17:33:00",
      "end_datetime": "2018-08-13 18:33:00",
      "related_activities": [
        {
          "oid": "3OacgZ9EH1",
          "ref": "activity-ref660"
        },
        {
          "oid": "20N6YOI4Vq",
          "ref": "activity-ref661"
        }
      ],
      "activity_code": "",
      "location_name": "",
      "track_ref": "WAKKAWAKKA",
      "track_oid": "e7NC2SSKPE",
      "presenters": [
        {
          "oid": "PzRZGiyTfm",
          "person_oid": "ukNJBwwoZy",
          "person_ref": "ukNJBwwoZy",
          "role": "MC",
          "created_at": "2018-08-13T17:33:15Z",
          "updated_at": "2018-08-13T17:33:15Z"
        }
      ],
      "parent_activity": {
        "ref": "activity-ref660"
      },
      "subsessions": [

      ],
      "assets": [

      ],
      "description": "A funeral and wake for Tim Finnegan who fell",
      "tags": [
        "funeral",
        "wake"
      ],
      "has_live_qa": true,
      "groups": [

      ],
      "entity_policies": [
        {
          "oid": "YleZWvNMgd",
          "ref": "YleZWvNMgd"
        }
      ],
      "session_state": null,
      "capacity_type": null
    }
  ]
}
Create Activity
POST
https://api.crowdcompass.com/v3/events/PQxSGBtysj/activities
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "activities": [
    {
      "ref": "fnrl4timf",
      "name": "Funeral for Tim Finnegan",
      "description": "A funeral and wake for Tim Finnegan who fell",
      "start_datetime": "2018-08-13 17:33",
      "end_datetime": "2018-08-13 18:33",
      "track_oid": "e7NC2SSKPE",
      "tags": [
        "funeral",
        "wake"
      ],
      "has_live_qa": true,
      "related_activities": [
        {
          "ref": "activity-ref660"
        },
        {
          "ref": "activity-ref661"
        }
      ],
      "presenters": [
        {
          "person_ref": "ukNJBwwoZy",
          "role": "MC"
        }
      ],
      "entity_policies": [
        {
          "ref": "YleZWvNMgd"
        }
      ],
      "parent_activity": {
        "ref": "activity-ref660"
      }
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 935
{
  "activities": [
    {
      "ref": "fnrl4timf",
      "oid": "HT8c7E2BtZ",
      "source": null,
      "source_url": null,
      "created_at": "2018-08-13T17:33:15Z",
      "updated_at": "2018-08-13T17:33:15Z",
      "name": "Funeral for Tim Finnegan",
      "start_datetime": "2018-08-13 17:33:00",
      "end_datetime": "2018-08-13 18:33:00",
      "related_activities": [
        {
          "oid": "3OacgZ9EH1",
          "ref": "activity-ref660"
        },
        {
          "oid": "20N6YOI4Vq",
          "ref": "activity-ref661"
        }
      ],
      "activity_code": "",
      "location_name": "",
      "track_ref": "WAKKAWAKKA",
      "track_oid": "e7NC2SSKPE",
      "presenters": [
        {
          "oid": "PzRZGiyTfm",
          "person_oid": "ukNJBwwoZy",
          "person_ref": "ukNJBwwoZy",
          "role": "MC",
          "created_at": "2018-08-13T17:33:15Z",
          "updated_at": "2018-08-13T17:33:15Z"
        }
      ],
      "parent_activity": {
        "ref": "activity-ref660"
      },
      "subsessions": [

      ],
      "assets": [

      ],
      "description": "A funeral and wake for Tim Finnegan who fell",
      "tags": [
        "wake",
        "funeral"
      ],
      "has_live_qa": true,
      "groups": [

      ],
      "entity_policies": [
        {
          "oid": "YleZWvNMgd",
          "ref": "YleZWvNMgd"
        }
      ],
      "session_state": null,
      "capacity_type": null
    }
  ]
}
Update an existing activity
PUT
https://api.crowdcompass.com/v3/events/PQxSGBtysj/activities/HT8c7E2BtZ
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "activities": [
    {
      "name": "foo",
      "assets": [
        {
          "oid": "I5fEjKEfw5"
        },
        {
          "ref": "VtQPofhl8S"
        }
      ],
      "groups": [
        {
          "oid": "Lq5Hhj6rfD"
        },
        {
          "ref": "ADtdUwPKP0"
        }
      ]
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 1656
{
  "activities": [
    {
      "ref": "fnrl4timf",
      "oid": "HT8c7E2BtZ",
      "source": null,
      "source_url": null,
      "created_at": "2018-08-13T17:33:15Z",
      "updated_at": "2018-08-13T17:33:15Z",
      "name": "foo",
      "start_datetime": "2018-08-13 17:33:00",
      "end_datetime": "2018-08-13 18:33:00",
      "related_activities": [
        {
          "oid": "3OacgZ9EH1",
          "ref": "activity-ref660"
        },
        {
          "oid": "20N6YOI4Vq",
          "ref": "activity-ref661"
        }
      ],
      "activity_code": "",
      "location_name": "",
      "track_ref": "WAKKAWAKKA",
      "track_oid": "e7NC2SSKPE",
      "presenters": [
        {
          "oid": "PzRZGiyTfm",
          "person_oid": "ukNJBwwoZy",
          "person_ref": "ukNJBwwoZy",
          "role": "MC",
          "created_at": "2018-08-13T17:33:15Z",
          "updated_at": "2018-08-13T17:33:15Z"
        }
      ],
      "parent_activity": {
        "ref": "activity-ref660"
      },
      "subsessions": [

      ],
      "assets": [
        {
          "asset_type": "DOCUMENT",
          "oid": "VtQPofhl8S",
          "ref": "VtQPofhl8S",
          "name": "lol_cat.pdf",
          "asset_url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/PQxSGBtysj/ce55faace7837e967203/lol_cat.:size.0.pdf",
          "processing_errors": null,
          "processing_status": "success"
        },
        {
          "asset_type": "IMAGE_MAIN",
          "oid": "I5fEjKEfw5",
          "ref": "I5fEjKEfw5",
          "name": "lol_cat.jpg",
          "asset_url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/PQxSGBtysj/4cf742cf72cc6cabbe07/lol_cat.:size.0.jpg",
          "processing_errors": null,
          "processing_status": "success"
        }
      ],
      "description": "A funeral and wake for Tim Finnegan who fell",
      "tags": [
        "wake",
        "funeral"
      ],
      "has_live_qa": true,
      "groups": [
        {
          "name": "Group numero 193!",
          "oid": "ADtdUwPKP0",
          "ref": "ADtdUwPKP0",
          "source": null
        },
        {
          "name": "Group numero 192!",
          "oid": "Lq5Hhj6rfD",
          "ref": "Lq5Hhj6rfD",
          "source": null
        }
      ],
      "entity_policies": [
        {
          "oid": "YleZWvNMgd",
          "ref": "YleZWvNMgd"
        }
      ],
      "session_state": null,
      "capacity_type": null
    }
  ]
}
Delete an activity record
DELETE
https://api.crowdcompass.com/v3/events/PQxSGBtysj/activities/HT8c7E2BtZ
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
People
Collection
/events/:event_oid/people (supports standard GET, POST)
Resource
/events/:event_oid/people/:oid (supports standard GET, PUT, DELETE)
Attribute Type Description
ref String used as an external identifier *
source String integration name (please contact CrowdCompass to enable this feature)
oid String 10 character unique identifier used by CrowdCompass. Do not send this attribute in any requests.
display_name String This will be comprised of first_name and last_name if not supplied. A value must be set for first_name, last_name, or display_name
tags Array optional - an array of strings
presenter_at Array optional - an array of presenter objects.
assets Array optional - an array of asset object refs or oids **
groups Array optional - an array of group object refs or oids
website String optional - if the website field does not include an "http://" or "https://" prefix in POST requests, the prefix "http://" will be prepended automatically.
website_2 String optional - if the website field does not include an "http://" or "https://" prefix in POST requests, the prefix "http://" will be prepended automatically.
phone_other_type String optional - if left blank, this field will default to "Main"
first_name String optional
last_name String optional
title String optional
organization_name String optional
bio String optional
address String optional
address_2 String optional
city String optional
state String optional
zipcode String optional
country String optional
phone_work String optional
phone_mobile String optional
phone_other String optional
email String optional
email_2 String optional
twitter_url String optional
facebook_url String optional
linkedin_url String optional
organization_ref String optional
organization_oid String optional

* ref is used for relating documents to 3rd party identifiers used outside of CrowdCompass's own internal identifiers and cannot exceed 64 characters.


** assets must be uploaded to CrowdCompass using the Create Asset endpoint before they can be referenced.

List People
GET
https://api.crowdcompass.com/v3/events/PWjtA8tO5M/people
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 842
{
  "people": [
    {
      "ref": "person-ref",
      "oid": "eH6pvjknp1",
      "created_at": "2018-08-13T17:33:15Z",
      "updated_at": "2018-08-13T17:33:15Z",
      "first_name": "Thomas",
      "last_name": "Tester",
      "display_name": "tester",
      "title": "Mr",
      "organization_name": "Widgets Co.",
      "bio": "I used to be an engineer when...",
      "address": "123 main str",
      "address_2": "",
      "city": "Hyannis",
      "state": "MA",
      "zipcode": "02601",
      "country": "US",
      "phone_work": "123-123-1234",
      "phone_mobile": "898-898-8989",
      "phone_other": "",
      "phone_other_type": "",
      "email": "test@example.org",
      "email_2": "",
      "website": "http://example.org",
      "website_2": "",
      "twitter_url": "",
      "facebook_url": "",
      "linkedin_url": "",
      "tags": [
        "tag1",
        "tag2"
      ],
      "presenter_at": [

      ],
      "assets": [

      ],
      "groups": [

      ],
      "organization_oid": "vxG97aG6s6",
      "organization_ref": "vxG97aG6s6",
      "source": null
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Show person
GET
https://api.crowdcompass.com/v3/events/PWjtA8tO5M/people/eH6pvjknp1
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 761
{
  "people": [
    {
      "ref": "person-ref",
      "oid": "eH6pvjknp1",
      "created_at": "2018-08-13T17:33:15Z",
      "updated_at": "2018-08-13T17:33:15Z",
      "first_name": "Thomas",
      "last_name": "Tester",
      "display_name": "tester",
      "title": "Mr",
      "organization_name": "Widgets Co.",
      "bio": "I used to be an engineer when...",
      "address": "123 main str",
      "address_2": "",
      "city": "Hyannis",
      "state": "MA",
      "zipcode": "02601",
      "country": "US",
      "phone_work": "123-123-1234",
      "phone_mobile": "898-898-8989",
      "phone_other": "",
      "phone_other_type": "",
      "email": "test@example.org",
      "email_2": "",
      "website": "http://example.org",
      "website_2": "",
      "twitter_url": "",
      "facebook_url": "",
      "linkedin_url": "",
      "tags": [
        "tag1",
        "tag2"
      ],
      "presenter_at": [

      ],
      "assets": [

      ],
      "groups": [

      ],
      "organization_oid": "vxG97aG6s6",
      "organization_ref": "vxG97aG6s6",
      "source": null
    }
  ]
}
Create person
POST
https://api.crowdcompass.com/v3/events/PWjtA8tO5M/people
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "people": [
    {
      "ref": "person-ref",
      "first_name": "Thomas",
      "last_name": "Tester",
      "display_name": "tester",
      "title": "Mr",
      "organization_name": "Widgets Co.",
      "bio": "I used to be an engineer when...",
      "address": "123 main str",
      "address_2": "",
      "city": "Hyannis",
      "state": "MA",
      "zipcode": "02601",
      "country": "US",
      "phone_work": "123-123-1234",
      "phone_mobile": "898-898-8989",
      "phone_other": "",
      "phone_other_type": "",
      "email": "test@example.org",
      "email_2": "",
      "website": "http://example.org",
      "website_2": "",
      "twitter_url": "",
      "facebook_url": "",
      "linkedin_url": "",
      "tags": [
        "tag1",
        "tag2"
      ],
      "presenter_at": [

      ],
      "assets": [

      ],
      "groups": [

      ],
      "organization_oid": "vxG97aG6s6"
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 761
{
  "people": [
    {
      "ref": "person-ref",
      "oid": "eH6pvjknp1",
      "created_at": "2018-08-13T17:33:15Z",
      "updated_at": "2018-08-13T17:33:15Z",
      "first_name": "Thomas",
      "last_name": "Tester",
      "display_name": "tester",
      "title": "Mr",
      "organization_name": "Widgets Co.",
      "bio": "I used to be an engineer when...",
      "address": "123 main str",
      "address_2": "",
      "city": "Hyannis",
      "state": "MA",
      "zipcode": "02601",
      "country": "US",
      "phone_work": "123-123-1234",
      "phone_mobile": "898-898-8989",
      "phone_other": "",
      "phone_other_type": "",
      "email": "test@example.org",
      "email_2": "",
      "website": "http://example.org",
      "website_2": "",
      "twitter_url": "",
      "facebook_url": "",
      "linkedin_url": "",
      "tags": [
        "tag2",
        "tag1"
      ],
      "presenter_at": [

      ],
      "assets": [

      ],
      "groups": [

      ],
      "organization_oid": "vxG97aG6s6",
      "organization_ref": "vxG97aG6s6",
      "source": null
    }
  ]
}
Update an existing person
PUT
https://api.crowdcompass.com/v3/events/PWjtA8tO5M/people/eH6pvjknp1
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "people": [
    {
      "email": "test@example.org",
      "display_name": "Fred",
      "city": "Portland",
      "state": "Oregon"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 764
{
  "people": [
    {
      "ref": "person-ref",
      "oid": "eH6pvjknp1",
      "created_at": "2018-08-13T17:33:15Z",
      "updated_at": "2018-08-13T17:33:15Z",
      "first_name": "Thomas",
      "last_name": "Tester",
      "display_name": "Fred",
      "title": "Mr",
      "organization_name": "Widgets Co.",
      "bio": "I used to be an engineer when...",
      "address": "123 main str",
      "address_2": "",
      "city": "Portland",
      "state": "Oregon",
      "zipcode": "02601",
      "country": "US",
      "phone_work": "123-123-1234",
      "phone_mobile": "898-898-8989",
      "phone_other": "",
      "phone_other_type": "",
      "email": "test@example.org",
      "email_2": "",
      "website": "http://example.org",
      "website_2": "",
      "twitter_url": "",
      "facebook_url": "",
      "linkedin_url": "",
      "tags": [
        "tag2",
        "tag1"
      ],
      "presenter_at": [

      ],
      "assets": [

      ],
      "groups": [

      ],
      "organization_oid": "vxG97aG6s6",
      "organization_ref": "vxG97aG6s6",
      "source": null
    }
  ]
}
Delete a person record
DELETE
https://api.crowdcompass.com/v3/events/PWjtA8tO5M/people/eH6pvjknp1
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Pages
Collection
/events/:event_oid/pages (supports standard GET, POST)
Resource
/events/:event_oid/pages/:oid (supports standard GET, PUT, DELETE)
Attribute Type Description
ref String used as an external identifier *
oid String 10 character unique identifier used by CrowdCompass. Do not send this attribute in any requests.
name String the name of the page.
description String optional - the page contents.
tags Array optional - an array of strings
assets Array optional - an array of asset object refs or oids **
groups Array optional - an array of group object refs or oids

* ref is used for relating documents to 3rd party identifiers used outside of CrowdCompass's own internal identifiers and cannot exceed 64 characters.


** assets must be uploaded to CrowdCompass using the Create Asset endpoint before they can be referenced.

List pages
GET
https://api.crowdcompass.com/v3/events/wQrQNlhs51/pages
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 299
{
  "pages": [
    {
      "ref": "page-ref",
      "oid": "6Ozd9Yhlls",
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Sample page",
      "description": "my cool page",
      "tags": [
        "tag2",
        "tag1"
      ],
      "groups": [

      ],
      "assets": [

      ]
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Show page
GET
https://api.crowdcompass.com/v3/events/wQrQNlhs51/pages/6Ozd9Yhlls
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 218
{
  "pages": [
    {
      "ref": "page-ref",
      "oid": "6Ozd9Yhlls",
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Sample page",
      "description": "my cool page",
      "tags": [
        "tag2",
        "tag1"
      ],
      "groups": [

      ],
      "assets": [

      ]
    }
  ]
}
Create page
POST
https://api.crowdcompass.com/v3/events/wQrQNlhs51/pages
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "pages": [
    {
      "ref": "page-ref",
      "name": "Sample page",
      "description": "my cool page",
      "tags": [
        "tag1",
        "tag2"
      ],
      "assets": [

      ],
      "groups": [

      ]
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 218
{
  "pages": [
    {
      "ref": "page-ref",
      "oid": "6Ozd9Yhlls",
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Sample page",
      "description": "my cool page",
      "tags": [
        "tag2",
        "tag1"
      ],
      "groups": [

      ],
      "assets": [

      ]
    }
  ]
}
Update an existing page
PUT
https://api.crowdcompass.com/v3/events/wQrQNlhs51/pages/6Ozd9Yhlls
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "pages": [
    {
      "description": "My even cooler page"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 225
{
  "pages": [
    {
      "ref": "page-ref",
      "oid": "6Ozd9Yhlls",
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Sample page",
      "description": "My even cooler page",
      "tags": [
        "tag2",
        "tag1"
      ],
      "groups": [

      ],
      "assets": [

      ]
    }
  ]
}
Delete a page record
DELETE
https://api.crowdcompass.com/v3/events/wQrQNlhs51/pages/6Ozd9Yhlls
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Tracks
Collection
/events/:event_oid/tracks (supports standard GET, POST)
Resource
/events/:event_oid/tracks/:ref (supports standard GET, PUT, DELETE)
Attribute Type Description
ref String used as an external identifier *
oid String 10 character unique identifier used by CrowdCompass. Do not send this attribute in any requests.
name String track name. Required
track_group_list String Comma-separated list of groups to add this track to.
sequence_number String Internal sort key. Do not send this attribute in any requests.
List tracks
GET
https://api.crowdcompass.com/v3/events/9Ifh9xIdTn/tracks
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 294
{
  "tracks": [
    {
      "ref": "remote-visitor-ref",
      "oid": "ks9TIsaV4v",
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Sample track",
      "track_group_list": "group 2,group 1",
      "sequence_number": "1"
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Show track
GET
https://api.crowdcompass.com/v3/events/9Ifh9xIdTn/tracks/ks9TIsaV4v
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 213
{
  "tracks": [
    {
      "ref": "remote-visitor-ref",
      "oid": "ks9TIsaV4v",
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Sample track",
      "track_group_list": "group 2,group 1",
      "sequence_number": "1"
    }
  ]
}
Create track
POST
https://api.crowdcompass.com/v3/events/9Ifh9xIdTn/tracks
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "tracks": [
    {
      "ref": "remote-visitor-ref",
      "name": "Sample track",
      "track_group_list": "group 1, group 2"
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 213
{
  "tracks": [
    {
      "ref": "remote-visitor-ref",
      "oid": "ks9TIsaV4v",
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Sample track",
      "track_group_list": "group 1,group 2",
      "sequence_number": "1"
    }
  ]
}
Update an existing track
PUT
https://api.crowdcompass.com/v3/events/9Ifh9xIdTn/tracks/ks9TIsaV4v
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "tracks": [
    {
      "name": "Another sample track"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 221
{
  "tracks": [
    {
      "ref": "remote-visitor-ref",
      "oid": "ks9TIsaV4v",
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Another sample track",
      "track_group_list": "group 2,group 1",
      "sequence_number": "1"
    }
  ]
}
Delete a track record
DELETE
https://api.crowdcompass.com/v3/events/9Ifh9xIdTn/tracks/ks9TIsaV4v
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Organizations
Collection
/events/:event_oid/organizations (supports standard GET, POST)
Resource
/events/:event_oid/organizations/:oid (supports standard GET, PUT, DELETE)
Attribute Type Description
ref String used as an external identifier *
oid String 10 character unique identifier used by CrowdCompass. Do not send this attribute in any requests.
name String organization name. Required
is_highlighted Boolean optional - designates sponsor organization. Set to true if a sponsorship_level is set.
sponsorship_level Object optional - Assigns an existing sponsorship level. Accepts "oid", "ref", and "name" keys.
has_lead_retrieval Boolean optional - field is only active IF lead retrieval is enabled for the event.
assets Array optional - an array of asset object refs or oids **
groups Array optional - an array of group object refs or oids
website String optional - if the website field does not include an "http://" or "https://" prefix in POST requests, the prefix "http://" will be prepended automatically.
website_2 String optional - if the website field does not include an "http://" or "https://" prefix in POST requests, the prefix "http://" will be prepended automatically.
phone_other_type String optional - if left blank, this field will default to "Main"
description String optional
tags String optional
location_name String optional
address String optional
address_2 String optional
city String optional
state String optional
zipcode String optional
country String optional
phone_work String optional
phone_mobile String optional
phone_other String optional
email String optional
email_2 String optional
twitter_url String optional
facebook_url String optional
linkedin_url String optional

* ref is used for relating documents to 3rd party identifiers used outside of CrowdCompass's own internal identifiers and cannot exceed 64 characters.


** assets must be uploaded to CrowdCompass using the Create Asset endpoint before they can be referenced.

List organizations
GET
https://api.crowdcompass.com/v3/events/zEczN4Dj5k/organizations
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 1118
{
  "organizations": [
    {
      "ref": "org-ref",
      "oid": "ghM4tkTcNK",
      "source": null,
      "source_url": null,
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Widget Corp",
      "description": "Leading the widget industry since 2008",
      "is_highlighted": true,
      "sponsorship_level": {
        "oid": "NCBBqdKWsX",
        "ref": "NCBBqdKWsX",
        "name": "Crystal Gem Sponsor 23"
      },
      "tags": [
        "Widget Industry",
        "Gold Sponsor"
      ],
      "location_name": "Booth 101A",
      "address": "4014 Widget Street",
      "address_2": "Suite 300",
      "city": "Widgeton",
      "state": "OR",
      "zipcode": "97206",
      "country": "US",
      "phone_work": "(555) 555-5050",
      "phone_mobile": "(555) 555-5005",
      "phone_other": "(555) 555-5550",
      "phone_other_type": "Fax",
      "email": "widgetco@example.com",
      "email_2": "sales@widgetco.example.com",
      "website": "http://example.com",
      "website_2": "http://example.com/widgetco",
      "twitter_url": "http://twitter.com/widgetexamplecom",
      "facebook_url": "http://facebook.com/widgetexamplecom",
      "linkedin_url": "http://linkedin.com/widgetexamplecom",
      "assets": [

      ],
      "groups": [

      ],
      "has_lead_retrieval": false,
      "entity_admin_emails": ""
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Show organization
GET
https://api.crowdcompass.com/v3/events/zEczN4Dj5k/organizations/ghM4tkTcNK
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 1037
{
  "organizations": [
    {
      "ref": "org-ref",
      "oid": "ghM4tkTcNK",
      "source": null,
      "source_url": null,
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Widget Corp",
      "description": "Leading the widget industry since 2008",
      "is_highlighted": true,
      "sponsorship_level": {
        "oid": "NCBBqdKWsX",
        "ref": "NCBBqdKWsX",
        "name": "Crystal Gem Sponsor 23"
      },
      "tags": [
        "Widget Industry",
        "Gold Sponsor"
      ],
      "location_name": "Booth 101A",
      "address": "4014 Widget Street",
      "address_2": "Suite 300",
      "city": "Widgeton",
      "state": "OR",
      "zipcode": "97206",
      "country": "US",
      "phone_work": "(555) 555-5050",
      "phone_mobile": "(555) 555-5005",
      "phone_other": "(555) 555-5550",
      "phone_other_type": "Fax",
      "email": "widgetco@example.com",
      "email_2": "sales@widgetco.example.com",
      "website": "http://example.com",
      "website_2": "http://example.com/widgetco",
      "twitter_url": "http://twitter.com/widgetexamplecom",
      "facebook_url": "http://facebook.com/widgetexamplecom",
      "linkedin_url": "http://linkedin.com/widgetexamplecom",
      "assets": [

      ],
      "groups": [

      ],
      "has_lead_retrieval": false,
      "entity_admin_emails": ""
    }
  ]
}
Create organization
POST
https://api.crowdcompass.com/v3/events/zEczN4Dj5k/organizations
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "organizations": [
    {
      "ref": "org-ref",
      "name": "Widget Corp",
      "description": "Leading the widget industry since 2008",
      "is_highlighted": true,
      "sponsorship_level": {
        "ref": "NCBBqdKWsX"
      },
      "tags": [
        "Gold Sponsor",
        "Widget Industry"
      ],
      "location_name": "Booth 101A",
      "address": "4014 Widget Street",
      "address_2": "Suite 300",
      "city": "Widgeton",
      "state": "OR",
      "zipcode": "97206",
      "country": "US",
      "phone_work": "(555) 555-5050",
      "phone_mobile": "(555) 555-5005",
      "phone_other": "(555) 555-5550",
      "phone_other_type": "Fax",
      "email": "widgetco@example.com",
      "email_2": "sales@widgetco.example.com",
      "website": "http://example.com",
      "website_2": "http://example.com/widgetco",
      "twitter_url": "http://twitter.com/widgetexamplecom",
      "facebook_url": "http://facebook.com/widgetexamplecom",
      "linkedin_url": "http://linkedin.com/widgetexamplecom",
      "assets": [

      ],
      "groups": [

      ],
      "has_lead_retrieval": true
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 1037
{
  "organizations": [
    {
      "ref": "org-ref",
      "oid": "ghM4tkTcNK",
      "source": null,
      "source_url": null,
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Widget Corp",
      "description": "Leading the widget industry since 2008",
      "is_highlighted": true,
      "sponsorship_level": {
        "oid": "NCBBqdKWsX",
        "ref": "NCBBqdKWsX",
        "name": "Crystal Gem Sponsor 23"
      },
      "tags": [
        "Widget Industry",
        "Gold Sponsor"
      ],
      "location_name": "Booth 101A",
      "address": "4014 Widget Street",
      "address_2": "Suite 300",
      "city": "Widgeton",
      "state": "OR",
      "zipcode": "97206",
      "country": "US",
      "phone_work": "(555) 555-5050",
      "phone_mobile": "(555) 555-5005",
      "phone_other": "(555) 555-5550",
      "phone_other_type": "Fax",
      "email": "widgetco@example.com",
      "email_2": "sales@widgetco.example.com",
      "website": "http://example.com",
      "website_2": "http://example.com/widgetco",
      "twitter_url": "http://twitter.com/widgetexamplecom",
      "facebook_url": "http://facebook.com/widgetexamplecom",
      "linkedin_url": "http://linkedin.com/widgetexamplecom",
      "assets": [

      ],
      "groups": [

      ],
      "has_lead_retrieval": false,
      "entity_admin_emails": ""
    }
  ]
}
Update an existing organization
PUT
https://api.crowdcompass.com/v3/events/zEczN4Dj5k/organizations/ghM4tkTcNK
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "organizations": [
    {
      "name": "proC tegdiW",
      "assets": [
        {
          "oid": "SkQj8FKKjM"
        },
        {
          "ref": "oGfZQA14HP"
        }
      ],
      "groups": [
        {
          "oid": "5kAgJUn5W2"
        },
        {
          "ref": "LOBRVK1Zq1"
        }
      ],
      "website": "http://www.example.org"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 1783
{
  "organizations": [
    {
      "ref": "org-ref",
      "oid": "ghM4tkTcNK",
      "source": null,
      "source_url": null,
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "proC tegdiW",
      "description": "Leading the widget industry since 2008",
      "is_highlighted": true,
      "sponsorship_level": {
        "oid": "NCBBqdKWsX",
        "ref": "NCBBqdKWsX",
        "name": "Crystal Gem Sponsor 23"
      },
      "tags": [
        "Widget Industry",
        "Gold Sponsor"
      ],
      "location_name": "Booth 101A",
      "address": "4014 Widget Street",
      "address_2": "Suite 300",
      "city": "Widgeton",
      "state": "OR",
      "zipcode": "97206",
      "country": "US",
      "phone_work": "(555) 555-5050",
      "phone_mobile": "(555) 555-5005",
      "phone_other": "(555) 555-5550",
      "phone_other_type": "Fax",
      "email": "widgetco@example.com",
      "email_2": "sales@widgetco.example.com",
      "website": "http://www.example.org",
      "website_2": "http://example.com/widgetco",
      "twitter_url": "http://twitter.com/widgetexamplecom",
      "facebook_url": "http://facebook.com/widgetexamplecom",
      "linkedin_url": "http://linkedin.com/widgetexamplecom",
      "assets": [
        {
          "asset_type": "DOCUMENT",
          "oid": "oGfZQA14HP",
          "ref": "oGfZQA14HP",
          "name": "lol_cat.pdf",
          "asset_url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/zEczN4Dj5k/64a8bc57de9d19af11cc/lol_cat.:size.0.pdf",
          "processing_errors": null,
          "processing_status": "success"
        },
        {
          "asset_type": "IMAGE_MAIN",
          "oid": "SkQj8FKKjM",
          "ref": "SkQj8FKKjM",
          "name": "lol_cat.jpg",
          "asset_url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/zEczN4Dj5k/48496acfa37e7f44d3a0/lol_cat.:size.0.jpg",
          "processing_errors": null,
          "processing_status": "success"
        }
      ],
      "groups": [
        {
          "name": "Group numero 195!",
          "oid": "LOBRVK1Zq1",
          "ref": "LOBRVK1Zq1",
          "source": null
        },
        {
          "name": "Group numero 194!",
          "oid": "5kAgJUn5W2",
          "ref": "5kAgJUn5W2",
          "source": null
        }
      ],
      "has_lead_retrieval": false,
      "entity_admin_emails": ""
    }
  ]
}
Delete a organization record
DELETE
https://api.crowdcompass.com/v3/events/zEczN4Dj5k/organizations/ghM4tkTcNK
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Appointments
Resource Plural
appointments
Collection
/events/:event_oid/appointments (supports standard GET, POST)
Resource
/events/:event_oid/appointments/:ref (supports standard GET, PUT, DELETE)
Attribute Type Description
ref String used as an external identifier *
name String appointment name. Required
description String optional
start_datetime string/timestamp relative to the event timezone. Required
end_datetime string/timestamp relative to the event timezone. Required
invitees Array an array of attendee refs. Requires at least one.
List appointments
GET
https://api.crowdcompass.com/v3/events/7sY7nUDUNB/appointments
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 460
{
  "appointments": [
    {
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Important appointment",
      "description": "An appointment to discuss things",
      "location_name": "Breakout room #1",
      "start_datetime": "2015-01-14 05:00:00",
      "end_datetime": "2015-01-14 06:30:00",
      "invitees": [
        {
          "email": null,
          "attendee_ref": "external-ref-48",
          "status": "unsent"
        }
      ],
      "ref": "A0987654"
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Show appointment
GET
https://api.crowdcompass.com/v3/events/7sY7nUDUNB/appointments/A0987654
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 379
{
  "appointments": [
    {
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Important appointment",
      "description": "An appointment to discuss things",
      "location_name": "Breakout room #1",
      "start_datetime": "2015-01-14 05:00:00",
      "end_datetime": "2015-01-14 06:30:00",
      "invitees": [
        {
          "email": null,
          "attendee_ref": "external-ref-48",
          "status": "unsent"
        }
      ],
      "ref": "A0987654"
    }
  ]
}
Create appointment
POST
https://api.crowdcompass.com/v3/events/7sY7nUDUNB/appointments
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "appointments": [
    {
      "ref": "A0987654",
      "name": "Important appointment",
      "description": "An appointment to discuss things",
      "location_name": "Breakout room #1",
      "start_datetime": "2015-01-14 05:00:00",
      "end_datetime": "2015-01-14 06:30:00",
      "invitees": [
        {
          "attendee_ref": "external-ref-48"
        }
      ]
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 379
{
  "appointments": [
    {
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Important appointment",
      "description": "An appointment to discuss things",
      "location_name": "Breakout room #1",
      "start_datetime": "2015-01-14 05:00:00",
      "end_datetime": "2015-01-14 06:30:00",
      "invitees": [
        {
          "email": null,
          "attendee_ref": "external-ref-48",
          "status": "unsent"
        }
      ],
      "ref": "A0987654"
    }
  ]
}
Update an existing appointment
PUT
https://api.crowdcompass.com/v3/events/7sY7nUDUNB/appointments/A0987654
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "appointments": [
    {
      "name": "tnemtnioppa tnatropmI"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 379
{
  "appointments": [
    {
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "tnemtnioppa tnatropmI",
      "description": "An appointment to discuss things",
      "location_name": "Breakout room #1",
      "start_datetime": "2015-01-14 05:00:00",
      "end_datetime": "2015-01-14 06:30:00",
      "invitees": [
        {
          "email": null,
          "attendee_ref": "external-ref-48",
          "status": "unsent"
        }
      ],
      "ref": "A0987654"
    }
  ]
}
Delete a appointment record
DELETE
https://api.crowdcompass.com/v3/events/7sY7nUDUNB/appointments/A0987654
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
External Appointments
Resource Plural
external_appointments
Collection
/events/:event_oid/external_appointments (supports standard GET, POST)
Resource
/events/:event_oid/external_appointments/:ref (supports standard GET, PUT, DELETE)
Attribute Type Description
ref String used as an external identifier *
name String appointment name. Required
description String description of the appointment. Optional.
location_name String location of the appointment. Required
start_datetime string/timestamp relative to the event timezone. Required
end_datetime string/timestamp relative to the event timezone. Required
invitees Array an array of invitee refs. Requires at least one.
organizers Array an array of organizer refs. Requires at least one.
planner_created Boolean currently optional. Soon to be required
auto_accept Boolean For appointments created by a planner, should be true or false. For appointments made by an attendee, should be null.
source String integration name (please contact CrowdCompass to enable this feature). Optional

* ref is used for relating documents to 3rd party identifiers used outside of CrowdCompass's own internal identifiers and cannot exceed 64 characters.

List external appointments
GET
https://api.crowdcompass.com/v3/events/13CwSFl2vP/external_appointments
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 630
{
  "external_appointments": [
    {
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Important appointment",
      "description": "An appointment to discuss things",
      "location_name": "Breakout room #1",
      "start_datetime": "2015-01-14 05:00:00",
      "end_datetime": "2015-01-14 06:30:00",
      "invitees": [
        {
          "ref": "external-ref-49",
          "attendee_ref": "external-ref-49",
          "status": "pending"
        }
      ],
      "organizers": [
        {
          "ref": "external-ref-50",
          "attendee_ref": "external-ref-50",
          "status": "pending"
        }
      ],
      "ref": "A0987654",
      "source": null,
      "auto_accept": null,
      "planner_created": null
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Show external appointment
GET
https://api.crowdcompass.com/v3/events/13CwSFl2vP/external_appointments/A0987654
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 549
{
  "external_appointments": [
    {
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Important appointment",
      "description": "An appointment to discuss things",
      "location_name": "Breakout room #1",
      "start_datetime": "2015-01-14 05:00:00",
      "end_datetime": "2015-01-14 06:30:00",
      "invitees": [
        {
          "ref": "external-ref-49",
          "attendee_ref": "external-ref-49",
          "status": "pending"
        }
      ],
      "organizers": [
        {
          "ref": "external-ref-50",
          "attendee_ref": "external-ref-50",
          "status": "pending"
        }
      ],
      "ref": "A0987654",
      "source": null,
      "auto_accept": null,
      "planner_created": null
    }
  ]
}
Create external appointment
POST
https://api.crowdcompass.com/v3/events/13CwSFl2vP/external_appointments
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "external_appointments": [
    {
      "ref": "A0987654",
      "name": "Important appointment",
      "description": "An appointment to discuss things",
      "location_name": "Breakout room #1",
      "start_datetime": "2015-01-14 05:00:00",
      "end_datetime": "2015-01-14 06:30:00",
      "invitees": [
        {
          "ref": "external-ref-49",
          "status": "pending"
        }
      ],
      "organizers": [
        {
          "ref": "external-ref-50",
          "status": "pending"
        }
      ]
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 549
{
  "external_appointments": [
    {
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "Important appointment",
      "description": "An appointment to discuss things",
      "location_name": "Breakout room #1",
      "start_datetime": "2015-01-14 05:00:00",
      "end_datetime": "2015-01-14 06:30:00",
      "invitees": [
        {
          "ref": "external-ref-49",
          "attendee_ref": "external-ref-49",
          "status": "pending"
        }
      ],
      "organizers": [
        {
          "ref": "external-ref-50",
          "attendee_ref": "external-ref-50",
          "status": "pending"
        }
      ],
      "ref": "A0987654",
      "source": null,
      "auto_accept": null,
      "planner_created": null
    }
  ]
}
Update an existing external appointment
PUT
https://api.crowdcompass.com/v3/events/13CwSFl2vP/external_appointments/A0987654
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "external_appointments": [
    {
      "name": "tnemtnioppa tnatropmI"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 549
{
  "external_appointments": [
    {
      "created_at": "2018-08-13T17:33:16Z",
      "updated_at": "2018-08-13T17:33:16Z",
      "name": "tnemtnioppa tnatropmI",
      "description": "An appointment to discuss things",
      "location_name": "Breakout room #1",
      "start_datetime": "2015-01-14 05:00:00",
      "end_datetime": "2015-01-14 06:30:00",
      "invitees": [
        {
          "ref": "external-ref-49",
          "attendee_ref": "external-ref-49",
          "status": "pending"
        }
      ],
      "organizers": [
        {
          "ref": "external-ref-50",
          "attendee_ref": "external-ref-50",
          "status": "pending"
        }
      ],
      "ref": "A0987654",
      "source": null,
      "auto_accept": null,
      "planner_created": null
    }
  ]
}
Delete a external appointment record
DELETE
https://api.crowdcompass.com/v3/events/13CwSFl2vP/external_appointments/A0987654
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Groups
Collection
/events/:event_oid/groups (supports standard GET, POST)
Resource
/events/:event_oid/groups/:ref (supports standard GET, PUT, DELETE)

Groups are limited to 300 per event.

Attribute Type Description
ref String used as an external identifier *
oid String 10 character unique identifier used by CrowdCompass. Do not send this attribute in any requests.
name String group name, unique, maximum of 100 characters. Required
source String integration name (please contact CrowdCompass to enable this feature)

* ref is used for relating documents to 3rd party identifiers used outside of CrowdCompass's own internal identifiers and cannot exceed 64 characters.

List groups
GET
https://api.crowdcompass.com/v3/events/HsJLKJao52/groups
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 251
{
  "groups": [
    {
      "oid": "RZHMzYGrB0",
      "created_at": "2018-08-13T17:33:17Z",
      "updated_at": "2018-08-13T17:33:17Z",
      "name": "Remote Visitor",
      "ref": "remote-visitor-ref",
      "source": null
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Show group
GET
https://api.crowdcompass.com/v3/events/HsJLKJao52/groups/RZHMzYGrB0
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 170
{
  "groups": [
    {
      "oid": "RZHMzYGrB0",
      "created_at": "2018-08-13T17:33:17Z",
      "updated_at": "2018-08-13T17:33:17Z",
      "name": "Remote Visitor",
      "ref": "remote-visitor-ref",
      "source": null
    }
  ]
}
Create group
POST
https://api.crowdcompass.com/v3/events/HsJLKJao52/groups
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "groups": [
    {
      "ref": "remote-visitor-ref",
      "name": "Remote Visitor"
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 170
{
  "groups": [
    {
      "oid": "RZHMzYGrB0",
      "created_at": "2018-08-13T17:33:17Z",
      "updated_at": "2018-08-13T17:33:17Z",
      "name": "Remote Visitor",
      "ref": "remote-visitor-ref",
      "source": null
    }
  ]
}
Update an existing group
PUT
https://api.crowdcompass.com/v3/events/HsJLKJao52/groups/RZHMzYGrB0
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "groups": [
    {
      "name": "Another sample group"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 176
{
  "groups": [
    {
      "oid": "RZHMzYGrB0",
      "created_at": "2018-08-13T17:33:17Z",
      "updated_at": "2018-08-13T17:33:17Z",
      "name": "Another sample group",
      "ref": "remote-visitor-ref",
      "source": null
    }
  ]
}
Delete a group record
DELETE
https://api.crowdcompass.com/v3/events/HsJLKJao52/groups/RZHMzYGrB0
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Banners
Collection
/events/:event_oid/banners (supports standard GET, POST)
Resource
/events/:event_oid/banners/:ref (supports standard GET, PUT, DELETE)
Attribute Type Description
ref String used as an external identifier *
oid String 10 character unique identifier used by CrowdCompass. Do not send this attribute in any requests.
name String required - banner name, maximum of 100 characters
banner_interval_seconds String optional - default is 3. Acceptable inputs are 3, 6, 9, 12, and 15
images Object required - see Banner Images
entity Object optional - entity to visit when banner is clicked, see Linked Entity
url String optional - URL to visit when banner is clicked
groups Array optional - an array of group object refs or oids

* ref is used for relating documents to 3rd party identifiers used outside of CrowdCompass's own internal identifiers and cannot exceed 64 characters.

Banner Images

Multiple images can be associated with a banner for display on different device types. Two image types are currently supported: "main" - 640 x 150 px for mobile phones; and "tablet" - 552 x 150 px for tablets and web interfaces. The "main" image type is required and the "tablet" size is optional. To upload a new image, set the "remote_url" attribute to a valid URL for that banner; the URL must point to a valid JPEG, PNG or GIF and must have the exact dimensions described above. The "remote_url" value must be different than the previously supplied value to trigger re-uploading a new image. See usage examples below.

Attribute Type Description
remote_url String optional - URL that the banner image was originally copied from. Change or set this attribute to upload a new image
url String read-only - the URL that attendees will use to load the banner image

Linked Entity

An action can be assigned to a banner so clicking or tapping on banner will take an attendee to a specific place in the event guide or to a URL in their web browser. To link a banner to a specific entity, an "entity" object needs to be provided that includes the entity's type and either its oid or ref. If a "url" attribute is also provided then the URL will always take precedence.

Attribute Type Description
type String required - type of entity to link, must be one of: "activity", "area", "geo_location", "organization", "page" or "person"
oid String optional - CrowdCompass identifier of the entity to link
ref String optional - external identifier of the entity to link
List banners
GET
https://api.crowdcompass.com/v3/events/dbfUYkomHP/banners
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 356
{
  "banners": [
    {
      "oid": "JbBT35zSsC",
      "ref": "spotlight-banner-1",
      "name": "Spotlight Banner",
      "images": {
        "main": {
          "url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/dbfUYkomHP/banners/JbBT35zSsC/main-image.original.1534181597.png?1534181597"
        }
      }
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Show banner
GET
https://api.crowdcompass.com/v3/events/dbfUYkomHP/banners/JbBT35zSsC
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 795
{
  "banners": [
    {
      "entity": {
        "oid": "jgf88i7uzz",
        "ref": "my-org-1",
        "type": "organization"
      },
      "groups": [

      ],
      "images": {
        "main": {
          "remote_url": "http://my.site/path/to/orig/main-image.png",
          "url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/dbfUYkomHP/banners/JbBT35zSsC/main-image.original.1534181597.png?1534181597"
        },
        "tablet": {
          "remote_url": "http://my.site/path/to/orig/tablet-image.png",
          "url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/dbfUYkomHP/banners/JbBT35zSsC/tablet-image.original.1534181597.png?1534181597"
        }
      },
      "oid": "JbBT35zSsC",
      "created_at": "2018-08-13T17:33:17Z",
      "updated_at": "2018-08-13T17:33:17Z",
      "name": "Spotlight Banner",
      "ref": "spotlight-banner-1",
      "url": "http://my.site/path/to/any/page",
      "banner_interval_seconds": 6
    }
  ]
}
Create banner
POST
https://api.crowdcompass.com/v3/events/dbfUYkomHP/banners
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "banners": [
    {
      "ref": "spotlight-banner-1",
      "name": "Spotlight Banner",
      "banner_interval_seconds": "6",
      "images": {
        "main": {
          "remote_url": "http://my.site/path/to/orig/main-image.png"
        },
        "tablet": {
          "remote_url": "http://my.site/path/to/orig/tablet-image.png"
        }
      },
      "entity": {
        "type": "organization",
        "ref": "my-org-1"
      },
      "url": "http://my.site/path/to/any/page",
      "groups": [

      ]
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 795
{
  "banners": [
    {
      "entity": {
        "oid": "jgf88i7uzz",
        "ref": "my-org-1",
        "type": "organization"
      },
      "groups": [

      ],
      "images": {
        "main": {
          "remote_url": "http://my.site/path/to/orig/main-image.png",
          "url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/dbfUYkomHP/banners/JbBT35zSsC/main-image.original.1534181597.png?1534181597"
        },
        "tablet": {
          "remote_url": "http://my.site/path/to/orig/tablet-image.png",
          "url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/dbfUYkomHP/banners/JbBT35zSsC/tablet-image.original.1534181597.png?1534181597"
        }
      },
      "oid": "JbBT35zSsC",
      "created_at": "2018-08-13T17:33:17Z",
      "updated_at": "2018-08-13T17:33:17Z",
      "name": "Spotlight Banner",
      "ref": "spotlight-banner-1",
      "url": "http://my.site/path/to/any/page",
      "banner_interval_seconds": 6
    }
  ]
}
Update an existing banner
PUT
https://api.crowdcompass.com/v3/events/dbfUYkomHP/banners/JbBT35zSsC
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "banners": [
    {
      "name": "Another sample banner"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 800
{
  "banners": [
    {
      "entity": {
        "oid": "jgf88i7uzz",
        "ref": "my-org-1",
        "type": "organization"
      },
      "groups": [

      ],
      "images": {
        "main": {
          "remote_url": "http://my.site/path/to/orig/main-image.png",
          "url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/dbfUYkomHP/banners/JbBT35zSsC/main-image.original.1534181597.png?1534181597"
        },
        "tablet": {
          "remote_url": "http://my.site/path/to/orig/tablet-image.png",
          "url": "https://v3-app-test-crowdc.s3.amazonaws.com/accounts/thatldopig/event_center/events/dbfUYkomHP/banners/JbBT35zSsC/tablet-image.original.1534181597.png?1534181597"
        }
      },
      "oid": "JbBT35zSsC",
      "created_at": "2018-08-13T17:33:17Z",
      "updated_at": "2018-08-13T17:33:17Z",
      "name": "Another sample banner",
      "ref": "spotlight-banner-1",
      "url": "http://my.site/path/to/any/page",
      "banner_interval_seconds": 6
    }
  ]
}
Delete a banner record
DELETE
https://api.crowdcompass.com/v3/events/dbfUYkomHP/banners/JbBT35zSsC
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Sponsorship Levels
Collection
/events/:event_oid/banners (supports standard GET, POST)
Resource
/events/:event_oid/banners/:ref (supports standard GET, PUT, DELETE)
Attribute Type Description
ref String used as an external identifier *
oid String 10 character unique identifier used by CrowdCompass. Do not send this attribute in any requests.
name String required - sponsorship level name, case sensitive

* ref is used for relating documents to 3rd party identifiers used outside of CrowdCompass's own internal identifiers and cannot exceed 64 characters.

List sponsorship levels
GET
https://api.crowdcompass.com/v3/events/aVBP66jTT6/sponsorship_levels
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 173
{
  "sponsorship_levels": [
    {
      "oid": "ezamhcd5eS",
      "name": "Garnet Sponsor",
      "ref": "garnet-sponsor"
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Show sponsorship level
GET
https://api.crowdcompass.com/v3/events/aVBP66jTT6/sponsorship_levels/ezamhcd5eS
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 92
{
  "sponsorship_levels": [
    {
      "oid": "ezamhcd5eS",
      "name": "Garnet Sponsor",
      "ref": "garnet-sponsor"
    }
  ]
}
Create sponsorship level
POST
https://api.crowdcompass.com/v3/events/aVBP66jTT6/sponsorship_levels
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "sponsorship_levels": [
    {
      "ref": "garnet-sponsor",
      "name": "Garnet Sponsor"
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 92
{
  "sponsorship_levels": [
    {
      "oid": "ezamhcd5eS",
      "name": "Garnet Sponsor",
      "ref": "garnet-sponsor"
    }
  ]
}
Update an existing sponsorship level
PUT
https://api.crowdcompass.com/v3/events/aVBP66jTT6/sponsorship_levels/ezamhcd5eS
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "sponsorship_levels": [
    {
      "name": "rosnopS tenraG"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 92
{
  "sponsorship_levels": [
    {
      "oid": "ezamhcd5eS",
      "name": "rosnopS tenraG",
      "ref": "garnet-sponsor"
    }
  ]
}
Delete a sponsorship level
DELETE
https://api.crowdcompass.com/v3/events/aVBP66jTT6/sponsorship_levels/ezamhcd5eS
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Custom Fields
Collection
/events/:event_oid/custom_fields/invitation (supports standard GET, POST)
Resource
/events/:event_oid/custom_fields/invitation/:ref (supports standard GET, PUT, DELETE)
Attribute Type Description
ref String used as an external identifier *
oid String 10 character unique identifier used by CrowdCompass. Do not send this attribute in any requests.
name String required - custom_field name, maximum of 50 characters
section String required - the profile section this field will appear in
entity_type String Internally managed attribute. Should be omitted from create and update requests.

* ref is used for relating documents to 3rd party identifiers used outside of CrowdCompass's own internal identifiers and cannot exceed 64 characters.

List custom fields
GET
https://api.crowdcompass.com/v3/events/0ZYuPjm1eI/custom_fields/invitation
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 225
{
  "custom_fields": [
    {
      "oid": "b1g31JdE5I",
      "section": "address",
      "ref": "custom_field_ref",
      "name": "Favorite Color",
      "entity_type": "AttendeeInvitation"
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 1,
    "total": 1
  }
}
Show custom field
GET
https://api.crowdcompass.com/v3/events/0ZYuPjm1eI/custom_fields/invitation/custom_field_ref
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 144
{
  "custom_fields": [
    {
      "oid": "b1g31JdE5I",
      "section": "address",
      "ref": "custom_field_ref",
      "name": "Favorite Color",
      "entity_type": "AttendeeInvitation"
    }
  ]
}
Create custom field
POST
https://api.crowdcompass.com/v3/events/0ZYuPjm1eI/custom_fields/invitation
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "custom_fields": [
    {
      "ref": "custom_field_ref",
      "name": "Favorite Color",
      "section": "Address"
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 144
{
  "custom_fields": [
    {
      "oid": "b1g31JdE5I",
      "section": "address",
      "ref": "custom_field_ref",
      "name": "Favorite Color",
      "entity_type": "AttendeeInvitation"
    }
  ]
}
Update an existing custom field
PUT
https://api.crowdcompass.com/v3/events/0ZYuPjm1eI/custom_fields/invitation/b1g31JdE5I
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "custom_fields": [
    {
      "name": "roloC etirovaF"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 144
{
  "custom_fields": [
    {
      "oid": "b1g31JdE5I",
      "section": "address",
      "ref": "custom_field_ref",
      "name": "roloC etirovaF",
      "entity_type": "AttendeeInvitation"
    }
  ]
}
Delete a custom field record
DELETE
https://api.crowdcompass.com/v3/events/0ZYuPjm1eI/custom_fields/invitation/b1g31JdE5I
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Integration Configs

Events can have Integration Configs to link a CrowdCompass event to an event on an external system, such as Cvent Core or Lanyon. Before any feature integrations can be turned on, the event first needs a base integration for the source system. Those base integrations contain the necessary information to link an event on CrowdCompass to an event on the external system. Once those are in place, integrations can be made for specific features. An event can only have one base config and any number of feature configs compatible with that base config.

Below are the possible base configs and the feature integrations permitted with those base configs:

  • CoreBase: SessionCapacity, CustomFields
  • LanyonBase: SessionCapacity

Other integrations exist in the CrowdCompass product but they are configured differently.

Collection
/events/:event_oid/integration_configs (supports standard GET, POST)
Resource
/events/:event_oid/integration_configs/:ref (supports standard GET, PUT, DELETE)
Attribute Type Description
ref String used as an external identifier *
oid String 10 character unique identifier used by CrowdCompass. Do not send this attribute in any requests.
kind String One of the integration kinds listed above. Required when creating an integration config. Also required when updating the fields that are specific to an integration. Optional if you are just changing the external ref.
environment String The Core environment to integrate with. Only applicable when kind is CoreBase, in which case it is required
event_stub String The ID of the event in the Core environment. Only applicable when kind is CoreBase, in which case it is required
event_guid String The ID of the event in the Lanyon. Only applicable when kind is LanyonBase, in which case it is required

* ref is used for relating documents to 3rd party identifiers used outside of CrowdCompass's own internal identifiers and cannot exceed 64 characters.

List integration configs
GET
https://api.crowdcompass.com/v3/events/4tUkPYav3k/integration_configs
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 281
{
  "integration_configs": [
    {
      "oid": "Brk2cVkwYc",
      "ref": "myLanyonIntegration",
      "kind": "LanyonBase",
      "event_guid": "lanyon-splanyon"
    },
    {
      "oid": "GeI25cvQrk",
      "ref": "mySessionIntegration",
      "kind": "SessionCapacity"
    }
  ],
  "pagination": {
    "limit": 100,
    "next": null,
    "offset": 0,
    "returned_records": 2,
    "total": 2
  }
}
Create a base integration config
POST
https://api.crowdcompass.com/v3/events/4tUkPYav3k/integration_configs
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "integration_configs": [
    {
      "ref": "myLanyonIntegration",
      "kind": "LanyonBase",
      "event_guid": "lanyon-splanyon"
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 125
{
  "integration_configs": [
    {
      "oid": "Brk2cVkwYc",
      "ref": "myLanyonIntegration",
      "kind": "LanyonBase",
      "event_guid": "lanyon-splanyon"
    }
  ]
}
Create a feature integration config

Once the base config is created (see above), you can create a feature integration for the event.

POST
https://api.crowdcompass.com/v3/events/4tUkPYav3k/integration_configs
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "integration_configs": [
    {
      "ref": "mySessionIntegration",
      "kind": "SessionCapacity"
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 100
{
  "integration_configs": [
    {
      "oid": "GeI25cvQrk",
      "ref": "mySessionIntegration",
      "kind": "SessionCapacity"
    }
  ]
}
Update an existing integration config

When you update an integration config, if you provide the kind field (regardless of whether the value is changing) you must supply the full configuration for the integration.

PUT
https://api.crowdcompass.com/v3/events/4tUkPYav3k/integration_configs/Brk2cVkwYc
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "integration_configs": [
    {
      "kind": "LanyonBase",
      "event_guid": "the-grand-lanyon"
    }
  ]
}
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 126
{
  "integration_configs": [
    {
      "oid": "Brk2cVkwYc",
      "ref": "myLanyonIntegration",
      "kind": "LanyonBase",
      "event_guid": "the-grand-lanyon"
    }
  ]
}
Delete an integration config
DELETE
https://api.crowdcompass.com/v3/events/4tUkPYav3k/integration_configs/Brk2cVkwYc
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
204 No Content
Cache-Control: no-cache
Vary: Origin
No body
Entity Policies
Collection
/events/:event_oid/entity_policies (supports standard POST)
Create entity policy
POST
https://api.crowdcompass.com/v3/events/VvzMR38Jzs/entity_policies
Access-Token: accessTokenForAdmin
Host: api.crowdcompass.com
Content-Type: application/json
{
  "entity_policies": [
    {
      "ref": "entity_policy_ref",
      "name": "Rule for Massage Sessions",
      "policy_type": "https://platform.crowdcompass.com/v1/policies/types/associated_session/v1",
      "parameters": {
        "minimum": 1,
        "maximum": 5
      }
    }
  ]
}
201 Created
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Vary: Origin
Content-Length: 304
{
  "entity_policies": [
    {
      "name": "Rule for Massage Sessions",
      "policy_type": "https://platform.crowdcompass.com/v1/policies/types/associated_session/v1",
      "parameters": {
        "minimum": 1,
        "maximum": 5
      },
      "oid": "JocPp5KZi9",
      "created_at": "2018-08-13T17:33:18Z",
      "updated_at": "2018-08-13T17:33:18Z",
      "ref": "entity_policy_ref"
    }
  ]
}