JAI CRM
Home Documentation API Calendar endpoints

Calendar endpoints

29 endpoints: Boot, Items, Attention, Me and more.

Every endpoint in Calendar: 29 operations across 13 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.

Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.

Sync

GET/api/calendar/sync/

Your Google Calendar and Outlook connections

curl -X GET https://app.jaicrm.ai/api/calendar/sync/ 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/calendar/sync/{provider}/connect

Where to send the browser to sign in to Google Calendar or Outlook

ParameterTypeRequiredNotes
providerstringRequiredThe record’s id.
curl -X GET https://app.jaicrm.ai/api/calendar/sync/RECORD_ID/connect 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/calendar/sync/{provider}/remake

Make the JAI CRM calendar again in your Google Calendar or Outlook

ParameterTypeRequiredNotes
providerstringRequiredThe record’s id.
curl -X POST https://app.jaicrm.ai/api/calendar/sync/RECORD_ID/remake 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/calendar/sync/{provider}/sync

Bring your Google Calendar or Outlook up to date now

ParameterTypeRequiredNotes
providerstringRequiredThe record’s id.
curl -X POST https://app.jaicrm.ai/api/calendar/sync/RECORD_ID/sync 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/calendar/sync/nudge

Ask for your connected calendars to be brought up to date

curl -X POST https://app.jaicrm.ai/api/calendar/sync/nudge 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/calendar/sync/restore

Put an item you removed in Google Calendar or Outlook back there

curl -X POST https://app.jaicrm.ai/api/calendar/sync/restore 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/calendar/sync/{provider}

Choose what goes to your Google Calendar or Outlook, and whether your busy time comes back

ParameterTypeRequiredNotes
providerstringRequiredThe record’s id.
curl -X PUT https://app.jaicrm.ai/api/calendar/sync/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/calendar/sync/{provider}

Disconnect your Google Calendar or Outlook (its JAI CRM calendar goes too)

ParameterTypeRequiredNotes
providerstringRequiredThe record’s id.
curl -X DELETE https://app.jaicrm.ai/api/calendar/sync/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Holidays

GET/api/calendar/holidays

The business’s holidays for a year

curl -X GET https://app.jaicrm.ai/api/calendar/holidays 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/calendar/holidays

Add a holiday for the business or one branch

curl -X POST https://app.jaicrm.ai/api/calendar/holidays 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/calendar/holidays/national

Add India’s national holidays for a year

curl -X POST https://app.jaicrm.ai/api/calendar/holidays/national 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/calendar/holidays/{id}

Remove a holiday

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X DELETE https://app.jaicrm.ai/api/calendar/holidays/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Blocks

POST/api/calendar/blocks

Block time for yourself: focus, away or travelling

curl -X POST https://app.jaicrm.ai/api/calendar/blocks 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/calendar/blocks/{id}

Change your blocked time

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X PATCH https://app.jaicrm.ai/api/calendar/blocks/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/calendar/blocks/{id}

Remove your blocked time

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X DELETE https://app.jaicrm.ai/api/calendar/blocks/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Items

GET/api/calendar/items

Everything on the calendar in a window of days (at most 62)

curl -X GET https://app.jaicrm.ai/api/calendar/items 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/calendar/items/ics

One calendar item as a calendar file (.ics)

curl -X GET https://app.jaicrm.ai/api/calendar/items/ics 
  -H 'Authorization: Bearer YOUR_API_KEY'

Settings

GET/api/calendar/settings

The business’s calendar settings

curl -X GET https://app.jaicrm.ai/api/calendar/settings 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/calendar/settings

Change the business’s calendar settings

curl -X PUT https://app.jaicrm.ai/api/calendar/settings 
  -H 'Authorization: Bearer YOUR_API_KEY'

Promises

POST/api/calendar/promises

Note a customer’s promise to pay an invoice on a day

curl -X POST https://app.jaicrm.ai/api/calendar/promises 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/calendar/promises/{id}

Move a promised payment, or mark it kept or broken

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X PATCH https://app.jaicrm.ai/api/calendar/promises/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Feed

POST/api/calendar/feed

Make (or remake) your private calendar link for Apple Calendar or any other calendar app

curl -X POST https://app.jaicrm.ai/api/calendar/feed 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/calendar/feed

Turn your private calendar link off

curl -X DELETE https://app.jaicrm.ai/api/calendar/feed 
  -H 'Authorization: Bearer YOUR_API_KEY'

Boot

GET/api/calendar/boot

The calendar’s settings, your own view, the kinds you can see and the people

curl -X GET https://app.jaicrm.ai/api/calendar/boot 
  -H 'Authorization: Bearer YOUR_API_KEY'

Attention

GET/api/calendar/attention

Overdue work, meetings and visits waiting for an outcome, open work with no next step, and work with no date

curl -X GET https://app.jaicrm.ai/api/calendar/attention 
  -H 'Authorization: Bearer YOUR_API_KEY'

Me

PUT/api/calendar/me

Your own calendar view: the view, the kinds you hide, your hours

curl -X PUT https://app.jaicrm.ai/api/calendar/me 
  -H 'Authorization: Bearer YOUR_API_KEY'

Compliance

POST/api/calendar/compliance/mark

Mark a PF, ESI, TDS or quarterly GST date done, or not done

curl -X POST https://app.jaicrm.ai/api/calendar/compliance/mark 
  -H 'Authorization: Bearer YOUR_API_KEY'

Brief

GET/api/calendar/brief

A briefing on a lead, customer or deal before you meet them

curl -X GET https://app.jaicrm.ai/api/calendar/brief 
  -H 'Authorization: Bearer YOUR_API_KEY'

Meetings

POST/api/calendar/meetings/{id}/outcome

Say how a meeting went

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X POST https://app.jaicrm.ai/api/calendar/meetings/RECORD_ID/outcome 
  -H 'Authorization: Bearer YOUR_API_KEY'

Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.