Sign in
Configurations

Create Configuration

Creates a Configuration object that you use to define settings and preferences for a scheduling session.

Duplicate email notifications

If the organizer in a scheduling session is a Microsoft account user, both the organizer and all attendees might receive duplicate email notifications, including booking confirmations, rescheduling and cancellation notifications, and reminders. This is because of the way Microsoft handles email notifications. If you set notifications in Scheduler, Microsoft also sends its own notifications to the event organizer and attendees. Microsoft doesn't provide a way to disable these notifications.

Metadata as additional fields

You can add metadata fields (type: metadata) to your Configuration to store custom information about a booking. For example, you can add campaign tags or keywords to track specific bookings.

Booking webhook notifications (booking.created, booking.rescheduled, booking.cancelled, booking.pending, and booking.reminder) include your metadata fields in booking_info.additional_fields. Calendar event webhooks (for example, event.updated) do not include them, and email notifications and booking forms don't display them.

To identify Scheduler-related changes in event webhooks instead, use the metadata that Scheduler stamps on the calendar events it creates. For more information, see the event.updated notification schema.

post/v3/grants/{grant_id}/scheduling/configurations

Request body

OR

Example request

{
  "availability": {
    "availability_rules": {
      "default_open_hours": [
        {
          "days": [
            0,
            1,
            2
          ],
          "start": "10:00",
          "end": "14:00",
          "timezone": "America/Chicago",
          "exdates": [
            "2006-01-18"
          ]
        }
      ],
      "default_specific_time_availability": [
        {
          "date": "2025-12-25",
          "start": "09:00",
          "end": "13:00",
          "timezone": "America/Toronto"
        }
      ],
      "only_specific_time_availability": true
    }
  },
  "event_booking": {
    "booking_type": "booking",
    "description": "Come ready to talk philosophy!",
    "location": "Central Library, room 203",
    "notify_participants": true,
    "reminders": [
      {
        "email_subject": "Reminder: Annual Philosophy Club Meeting",
        "minutes_before_event": 30,
        "recipient": "host",
        "type": "email"
      }
    ],
    "timezone": "America/Chicago",
    "title": "Annual Philosophy Club Meeting"
  },
  "participants": [
    {
      "availability": {
        "open_hours": [
          {
            "days": [
              0,
              1,
              2
            ],
            "start": "10:00",
            "end": "14:00",
            "timezone": "America/Chicago",
            "exdates": [
              "2006-01-18"
            ]
          }
        ]
      },
      "email": "nyla@example.com",
      "name": "Nyla",
      "specific_time_availability": [
        {
          "date": "2025-08-21",
          "start": "09:00",
          "end": "17:00",
          "timezone": "America/Toronto"
        }
      ],
      "only_specific_time_availability": true,
      "timezone": "America/Toronto"
    }
  ],
  "scheduler": {
    "notetaker_settings": {
      "enabled": true,
      "show_ui_consent_message": true,
      "notetaker_name": "Sales Recording Bot",
      "meeting_settings": {
        "action_items": true,
        "action_items_settings": {
          "custom_instructions": "Only return the 5 most important action items."
        },
        "audio_recording": true,
        "leave_after_silence_seconds": 360,
        "summary": true,
        "summary_settings": {
          "custom_instructions": "Return this summary in the MEDPIC sales methodology."
        },
        "transcription": true,
        "video_recording": true,
        "transcription_settings": {
          "expected_languages": [
            "en",
            "es"
          ],
          "fallback_language": "en",
          "keywords": [
            "Nylas",
            "AssemblyAI"
          ],
          "use_speaker_names_as_keywords": true
        }
      }
    }
  }
}

Response

Configuration returned

OR

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.