Scheduling Links

The scheduling links API allows organizations to search and retrieve a user's available calendar linksmodel by email address.

Off by default

This feature is not enabled by default. You must request that it be enabled in your organization. Once activated, you will recieve your organization's id, which is used as part of the URL for the link.

Search Scheduling Links

GET /calendarviews

api_server=api.cirrusinsight.com
org_id=00000000-0000-0000-0000-000000000000
email_list=user@example.com,other@example.com
curl -G "https:/${api_server}/api/organizations/${org_id}/calendarviews" \
-d "emails=${email_list}"

Parameters

---

organization string

The Cirrus Insight orgnaization id for your company. This is formatted as a UUID.

---

emails string

A comma-separated list of email addresses to search for calendar links.

---

Response

{
    "calendarViews": [
        {
            "email":"",
            "calendars": [
                {
                    "url":"",
                    "name":"",
                    "isPrimary":true
                },
                {
                    "url": "",
                    "name":"",
                    "isPrimary":false
                }
            ]
        }
    ],
    "status":"Success",
    "message":"Success"
}

Fields

---

calendarViews list

(optional) A list of calendar linkmodel objects, one for each matching email from the request. If no calendars are found, this list may be empty or omitted from the response.

---

status string

Information on the status of the request.

---

message string

Information on the status of the request.

Errors

If the specified organization is not found, or if it does not have the Scheduling Links api enabled, it will return NotFound.

{
    "Status": "NotFound",
    "Message": "Not found.",
    "Errors": [
        {
            "Code": "not_found",
            "Description": "Not found."
            }
    ]
}

Use Cases

Use Case 1 - Use Cirrus Insight API to automate bookings on your website

A common use case for our customers in Banking and Financial Services is to auto-generate Cirrus Insight's calendar scheduling link for their website’s customer portal.

Typically large-sized financial services or banking firms will have many local and regional branches across the state. Each branch has a specific number of financial advisors, wealth managers, and consultants working at different hours. Employee transfer between different branches is common.

For example, let's look at ABC Financial Services. When Sean (ABC’s customer) visits ABC.com. ABC wants to assign him to an advisor at a branch that is closest to his location. Each branch might have different divisions or business units (Banking, Retirement Planning, Investing, etc). So if Sean wants assistance in retirement planning, the site may display a webform similar to this one:

Please Enter Your Address

Raleigh, NC

Please Choose Type of service

Retirement Planning

We matched 4 advisors to you. Please select one

Mark W

At the final step, your application backend can call the Scheduling Links API with Mark W's email address. Your app can then directly display (iframe) or forward to the advisors personalized calendar linkmodel.

Smart Schedule

This scenario is so common, Cirrus Insight has built it directly into our scheduling suite as Smart Schedule. With Smart Schedule you can setup up calendars that match users with the best meeting host based on a series of questions as well as criteria such as availability or utilization.

Learn how to Automate Lead Routing with Smart Scheduler.

Advantages

• When an advisor gets reassigned to a different branch, ABC does not need to worry about updating Cirrus Insight's calendar link. Your integration can query calendars of any available advisors in your branch website as long as your advisor database is up-to-date. You can request multiple calendar links at the same time.
• Every new addition or removal of an advisor from a branch, you can display their booking pages with just their email address.

Use Case 2 - Email marketing / Customer Success flows

Customer Success teams primarily work with high-value customers of your business. If you run a SAAS technology business, your development team is shipping new features and fixing defects often.

Customer Success and Sales teams are usually assigned to a specific segment - Industry, Enterprise or SMB, Location, Vertical, etc. Your marketing team may push out email campaigns for Product Updates or Onboarding using a template similar to the one below:

Email Template

Hello, We have released new features. Now our app is super fast, we have fixed defects and now you can execute your actions at 10x speed. Please click the link below to book a time with {your_advisor}.

{advisor_calendar_link}

In the above template, the variable tag {your_advisor} will be pre-filled by your marketing software (Marketo, Pardot, Hubspot, etc) for different customers based on some criteria, for example:

• mary@cooltech.com for real estate
• sean@cooltech.com for finance
• jonathan@cooltech.com for health care

Now using Cirrus Insight calendar API, you can also use the advisors email address to fetch their personalized calendar linkmodel and include it in the personalized email as well.

Advantages

• When a customer grows in size or is assigned to a different rep, as soon as your database is updated your app can automatically call the Scheduling Links API with the new rep’s email address for these types of campaigns. This helps you to automate workflows, minimize errors, and saves time for your team members.