Search API documentation

Type to search the API docs.

Invite Someone from Your Event Team to Join Your Workspace

Invite a colleague as an Admin, Team Member or Guest, choose what they can see and do, and re-send the invitation if it gets lost.

Example use case

A new coordinator joins your trade show team on Monday. Your onboarding tool invites them to ExhibitDay as a Team Member with the usual Team Member access, except Event Logs and the Workspace Activity Feed.

What you'll end up with

An open invitation for one email address, with the role, permissions and content restrictions you chose, and its invitation ID.

Before you start

Have a workspace API key and the person's work email address. Decide whether they should be an Admin, a Team Member or a Guest.

Good to know

The invitation email goes out as soon as the invitation is saved. The person joins your workspace only after they accept it and sign in or create an ExhibitDay account.

At a glance

Time to try

About 10 minutes

Effect on your data

Creates records

Endpoints

6

The example creates one workspace invitation and emails it right away. Re-sending sends another email. The other requests only read.

How it works

  1. Check Users & Permissions and the open invitations for the email address.
  2. For a Team Member or Guest, check your permission choices against the workspace's list.
  3. Create the invitation with one Idempotency-Key, then read it back.

Roles, permissions and content restrictions

Everyone you invite gets one of three roles. They are the same choices as Invite a User under Workspace Settings > Users & Permissions.

Roleworkspace_role_idWhat it means on the website
Admin1Admin / Full Access. Every permission and no content restrictions.
Team Member2Signs in and works in your workspace. You choose which areas they can view and change.
Guest3Guest (read-only). Signs in to view the areas you allow. A Guest can't be given permissions to change things.
  • Permissions turn on or off what a Team Member or Guest can see and do. On the website they're grouped as Event Management (General, Booth, Staff / Attendees, Travel, Asset Reservations, Giveaways, Shipments, Sponsorships, Misc. Event-Specific Expenses & Credits, Playbook, Tasks and your Special tab), Event History/Logs and Workspace Activity, AI Assistant (Planna), Asset Management Area, Budgets, ROI, Objectives & ROO, and Workspace Management. Examples: “Has access to view event Booth tab” and “Can add/update/delete tasks assigned only to self (this user)”.
  • Content Restrictions limit which records a Team Member or Guest sees, even in areas they can open.
Content Restriction (as the website shows it)Send in content_restrictions
User can only access his/her Events (Events they created or are tagged in, for example as an attendee or a Task's Assignee)only_my_events
User can only see Travel Reservations that the user either created, or is tagged inonly_my_travel
User can only see Playbook items that the user either created, or is tagged inonly_my_playbook
Only sees user's own activity in the Activity Feedonly_my_activity
Hide summary details for related items this user can't viewonly_accessible_related_items
  • The API sends permissions as the ones to deny. Leave permission_denial_ids out to give the role its usual defaults. Send [] to deny nothing the role can choose. A list denies exactly the permissions in it, so include the role's default denials you want to keep. Each permission's default in Step 3 shows them.
  • Your workspace's list of permissions, with each role's default, comes from GET /v1/references/permissions_and_content_restrictions. A permission your workspace doesn't use isn't listed.
  • Some choices depend on others, as on the website. Denying a permission also denies the permissions that need it. only_my_events, only_my_travel and only_my_playbook also turn on only_my_activity. When this changes your request, the invitation is still created and the X-API-Warnings response header lists each change.

Resources

A Resource is a non-user, such as a speaker, a contractor or temp staff. You add Resources on the website with Add a Resource (non-user) under Users & Permissions. Resources can't sign in, and you can't create them through the API. GET /v1/workspace_settings/users with filter_by_is_resource=true lists them. Tasks can't be assigned to Resources. To give a Resource access, invite their email address as a user. The website can then merge the Resource with the new user.

Check, invite and confirm

Step 1: Check whether they're in Users & Permissions

Look up the whole email address among the workspace's users and Resources.

curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users?filter_by_email=jordan%40example.org" -H "Authorization: Bearer YOUR_API_KEY"

Check: An empty list_data means no active user or Resource has this email. If a row comes back with is_resource true, the person is a Resource. Invite them only if they now need to sign in.

Step 2: Check for an open invitation

Make sure nobody has invited this address yet.

curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users/invitations?filter_by_email=jordan%40example.org" -H "Authorization: Bearer YOUR_API_KEY"

Check: If a row comes back, keep its id and see Step 5 instead of inviting again. status is Pending until the person accepts, then Accepted, not yet joined until they join.

Step 3: Choose permissions and content restrictions

For a Team Member or Guest, read the choices your workspace offers. Skip this step for an Admin.

curl -X GET "https://api.exhibitday.com/v1/references/permissions_and_content_restrictions" -H "Authorization: Bearer YOUR_API_KEY"

Example response (shortened)

{
  "list_data": [
    {
      "type": "permission",
      "permission_id": 8,
      "name": "Can update event booth information (under the event Booth tab)",
      "roles": [
        {
          "workspace_role_id": 2,
          "workspace_role": "Team Member",
          "can_be_set": true,
          "default": "allowed"
        },
        {
          "workspace_role_id": 3,
          "workspace_role": "Guest",
          "can_be_set": false,
          "default": "denied"
        }
      ]
    },
    {
      "type": "permission",
      "permission_id": 11,
      "name": "Can add/update/delete tasks assigned only to self (this user)",
      "roles": [
        {
          "workspace_role_id": 2,
          "workspace_role": "Team Member",
          "can_be_set": true,
          "default": "allowed"
        },
        {
          "workspace_role_id": 3,
          "workspace_role": "Guest",
          "can_be_set": false,
          "default": "denied"
        }
      ]
    }
  ]
}

Check: Use permission_id values in permission_denial_ids and content_restriction names in content_restrictions. Choose only rows where can_be_set is true for your role.

Step 4: Send the invitation

Send the email address and role. Add the header Idempotency-Key: YOUR_UNIQUE_KEY so a retry can reuse the original result. This example invites a Team Member, keeps the role's default denials (1, 2, 3, 12, 19, 31 and 32) and also denies 35, Event Logs and the Workspace Activity Feed.

curl -X POST "https://api.exhibitday.com/v1/workspace_settings/users/invitations" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"email\":\"jordan@example.org\",\"workspace_role_id\":2,\"permission_denial_ids\":[1,2,3,12,19,31,32,35]}"

Example response (shortened)

{
  "id": 12345,
  "email": "jordan@example.org",
  "status": "Pending",
  "workspace_role_id": 2,
  "workspace_role": "Team Member",
  "permission_denials": [
    {
      "id": 1,
      "name": "Illustrative permission definition"
    },
    {
      "id": 2,
      "name": "Illustrative permission definition"
    },
    {
      "id": 3,
      "name": "Illustrative permission definition"
    },
    {
      "id": 12,
      "name": "Illustrative permission definition"
    },
    {
      "id": 19,
      "name": "Illustrative permission definition"
    },
    {
      "id": 31,
      "name": "Illustrative permission definition"
    },
    {
      "id": 32,
      "name": "Illustrative permission definition"
    },
    {
      "id": 35,
      "name": "Illustrative permission definition"
    }
  ],
  "send_invitation_email": true,
  "record_revision": "r1:H63G2_yEc-scqWFhq647LFYlVxTpapbwQoK6irVnddM"
}

Other ways to invite:

To inviteSend
An Adminworkspace_role_id=1, with no permission_denial_ids or content_restrictions
A Team Member with the role's defaultsworkspace_role_id=2, and leave out permission_denial_ids
A Guest who sees only their own Travel Reservationsworkspace_role_id=3 and content_restrictions with only_my_travel and only_my_activity set to true
Someone you'll email laterAdd send_invitation_email=false. The invitation waits until you re-send it.

Check: Save the invitation id. Compare permission_denials and content_restrictions in the full response with what you meant to send, and read the X-API-Warnings header for any changes ExhibitDay made.

Step 5: Re-send an invitation that got lost

Email an open invitation again, the same way Re-send Invitation works on the website. To re-send only if nothing changed, add expected_revision with the record_revision from Step 6.

curl -X POST "https://api.exhibitday.com/v1/workspace_settings/users/invitations/resend" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345}"

Check: Each successful request sends another email, so don't retry blindly. Leave out Idempotency-Key. This request refuses it. If you get record_changed (HTTP 409), read the invitation again before deciding whether to re-send.

Step 6: Confirm what was saved

Read the invitation by ID to see its saved role, permissions and content restrictions.

curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users/invitations/info?id=12345&%24include_record_revision=true" -H "Authorization: Bearer YOUR_API_KEY"

Check: Confirm the email, role and access match your intent. Keep record_revision if you plan to re-send or revoke the invitation later.

Try it

Before running the example

ValueWhat to put in it
YOUR_API_KEYYour workspace API key. Keep it out of shared code and logs.
emailThe email address of the person to invite. The example uses jordan@example.org. Use your own test address.
workspace_role_id1 Admin, 2 Team Member or 3 Guest. The example invites a Team Member.
permission_denial_idsThe permission IDs to deny, from Step 3. The example sends the Team Member default denials plus 35 (Event Logs and the Workspace Activity Feed). Leave it out for the role's defaults.

Copy the complete example in your language and run it. To try another step, change the request to match one of the steps above.

Complete example program

Code Samples
curl -X POST "https://api.exhibitday.com/v1/workspace_settings/users/invitations" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"email\":\"jordan@example.org\",\"workspace_role_id\":2,\"permission_denial_ids\":[1,2,3,12,19,31,32,35]}"

Example response

{
  "id": 12345,
  "email": "jordan@example.org",
  "status_id": 1,
  "status": "Pending",
  "workspace_role_id": 2,
  "workspace_role": "Team Member",
  "invited_by": {
    "id": null,
    "first_name": "ExhibitDay",
    "last_name": "API",
    "display_name": "ExhibitDay API",
    "email": null,
    "type": null,
    "workspace_role": null,
    "is_active": true
  },
  "invitation_created_timestamp": "2030-01-15T12:00:00",
  "invitation_accepted_timestamp": null,
  "permission_denials": [
    {
      "id": 1,
      "name": "Illustrative permission definition"
    },
    {
      "id": 2,
      "name": "Illustrative permission definition"
    },
    {
      "id": 3,
      "name": "Illustrative permission definition"
    },
    {
      "id": 12,
      "name": "Illustrative permission definition"
    },
    {
      "id": 19,
      "name": "Illustrative permission definition"
    },
    {
      "id": 31,
      "name": "Illustrative permission definition"
    },
    {
      "id": 32,
      "name": "Illustrative permission definition"
    },
    {
      "id": 35,
      "name": "Illustrative permission definition"
    }
  ],
  "content_restrictions": {
    "only_my_events": false,
    "only_my_travel": false,
    "only_my_playbook": false,
    "only_my_activity": false,
    "only_accessible_related_items": false
  },
  "send_invitation_email": true,
  "record_revision": "r1:H63G2_yEc-scqWFhq647LFYlVxTpapbwQoK6irVnddM"
}
Note: POST /v1/workspace_settings/users/invitations - HTTP 200. The new invitation for a Team Member, with the permissions it denies. Keep the returned id to re-send or check the invitation.

The curl example uses Bash. Node.js needs version 18 or later (save as .mjs). Python uses Requests. C# needs a .NET 8 console project (Program.cs). Java needs Java 11 or later (ExhibitDayExample.java). PHP needs PHP with cURL. Ruby and Go use their standard libraries.

Things to keep in mind

  • The API invites one email address per request. The website can invite several at once on some plans.
  • Your plan decides who you can invite. A workspace on a plan with Admin invitations only refuses Team Member and Guest invitations. Plans also limit the number of users and Admins. A full workspace returns invalid_request (HTTP 400) and saves nothing.
  • To control spam, ExhibitDay refuses some email addresses and email providers. The API then returns invalid_request (HTTP 400) and saves nothing. Use another address.
  • Invitations created through the API send ExhibitDay's API invitation email, which doesn't name a person as the inviter. invited_by returns the ExhibitDay API.
  • A successful response doesn't confirm the email was delivered. If the email couldn't be sent, the invitation is still saved and X-API-Warnings says so. Use Re-send.
  • If you lose the response, retry the exact request with the same key. If you can't tell whether it worked, check for an open invitation (Step 2) before you invite again.
  • Inviting someone doesn't change an existing user's permissions. Change those on the website in Users & Permissions.