Skip to content
Skip to main content

Scheduler support for Agent Accounts

Agent AccountsSchedulerCalendar

Agent Account grants now work with Nylas Scheduler. Point a Configuration at an Agent Account’s grant_id and the agent becomes the organizer: guests book against the agent’s own calendar, the confirmation email sends from the agent’s own address, and the booking lands on the agent’s primary calendar. A scheduling agent no longer has to borrow a human’s connected grant to hold a booking page.

Added

Section titled “Added”

  • Configurations on Agent Account grants. POST /v3/grants/{grant_id}/scheduling/configurations accepts an Agent Account grant ID, along with the rest of the Configurations CRUD. Public and private Configurations both work, and a public Configuration with a slug still gets hosted under book.nylas.com.

    curl --request POST \
      --url 'https://api.us.nylas.com/v3/grants/<AGENT_ACCOUNT_GRANT_ID>/scheduling/configurations' \
      --header 'Authorization: Bearer <NYLAS_API_KEY>' \
      --header 'Content-Type: application/json' \
      --data '{
        "name": "Support callback",
        "participants": [{
          "name": "Support Agent",
          "email": "[email protected]",
          "is_organizer": true,
          "availability": { "calendar_ids": ["primary"] },
          "booking": { "calendar_id": "primary" }
        }],
        "availability": { "duration_minutes": 30 },
        "event_booking": { "title": "Support callback", "booking_type": "booking" }
      }'

  • Availability, sessions, and bookings. GET /v3/scheduling/availability, POST /v3/scheduling/sessions, and the Bookings endpoints all behave the same way against an Agent Account organizer. Both booking types work, including organizer-confirmation.

  • The five booking.* webhook triggers fire for Agent Account organizers with the same payloads: booking.created, booking.pending, booking.rescheduled, booking.cancelled, and booking.reminder.

Known limits

Section titled “Known limits”
  • Round-robin Configurations aren’t supported. An Agent Account can’t be a host under max-fairness or max-availability. One-on-one, collective, and group meeting types all work. To rotate across a pool of agents, keep one Configuration per Agent Account and choose the booking link in your own code.
  • Primary calendars only. Set availability.calendar_ids to ["primary"] and booking.calendar_id to "primary" on every Agent Account participant. Additional calendars on the account are ignored for both availability and booking.

Updated docs

Section titled “Updated docs”