Update organization team workflow

curl --request PATCH \
  --url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/workflows/{workflowId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Platform Test Workflow",
  "activation": {
    "isActiveOnAllEventTypes": false,
    "activeOnEventTypeIds": [
      698191
    ]
  },
  "trigger": {
    "offset": {
      "value": 24,
      "unit": "hour"
    },
    "type": "beforeEvent"
  },
  "steps": [
    {
      "action": "email_address",
      "stepNumber": 1,
      "recipient": "attendee",
      "template": "reminder",
      "sender": "<string>",
      "verifiedEmailId": "31214",
      "includeCalendarEvent": true,
      "message": {
        "subject": "Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com",
        "html": "<p>This is a reminder from {ORGANIZER} of {EVENT_NAME} to {ATTENDEE} starting here  {LOCATION} {MEETING_URL} at {START_TIME_h:mma} {TIMEZONE}.</p>"
      },
      "id": 67244
    }
  ]
}
'

{
  "status": "success",
  "data": [
    {
      "id": 101,
      "name": "Platform Test Workflow",
      "type": "event-type",
      "activation": {
        "isActiveOnAllEventTypes": false,
        "activeOnEventTypeIds": [
          698191,
          698192
        ]
      },
      "trigger": {
        "type": "beforeEvent",
        "offset": {
          "value": 24,
          "unit": "hour"
        }
      },
      "steps": [
        {
          "id": 67244,
          "stepNumber": 1,
          "recipient": "const",
          "template": "reminder",
          "sender": "Cal.com Notifications",
          "message": {
            "subject": "Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com",
            "html": "<p>Reminder for {EVENT_NAME}.</p>",
            "text": "Reminder for {EVENT_NAME}."
          },
          "action": "email_host",
          "email": 31214,
          "phone": "<string>",
          "phoneRequired": true,
          "includeCalendarEvent": true
        }
      ],
      "userId": 2313,
      "teamId": 4214321,
      "createdAt": "2024-05-12T10:00:00.000Z",
      "updatedAt": "2024-05-12T11:30:00.000Z"
    }
  ]
}

PATCH

organizations

{orgId}

teams

{teamId}

workflows

{workflowId}

Update organization team workflow

curl --request PATCH \
  --url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/workflows/{workflowId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Platform Test Workflow",
  "activation": {
    "isActiveOnAllEventTypes": false,
    "activeOnEventTypeIds": [
      698191
    ]
  },
  "trigger": {
    "offset": {
      "value": 24,
      "unit": "hour"
    },
    "type": "beforeEvent"
  },
  "steps": [
    {
      "action": "email_address",
      "stepNumber": 1,
      "recipient": "attendee",
      "template": "reminder",
      "sender": "<string>",
      "verifiedEmailId": "31214",
      "includeCalendarEvent": true,
      "message": {
        "subject": "Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com",
        "html": "<p>This is a reminder from {ORGANIZER} of {EVENT_NAME} to {ATTENDEE} starting here  {LOCATION} {MEETING_URL} at {START_TIME_h:mma} {TIMEZONE}.</p>"
      },
      "id": 67244
    }
  ]
}
'

{
  "status": "success",
  "data": [
    {
      "id": 101,
      "name": "Platform Test Workflow",
      "type": "event-type",
      "activation": {
        "isActiveOnAllEventTypes": false,
        "activeOnEventTypeIds": [
          698191,
          698192
        ]
      },
      "trigger": {
        "type": "beforeEvent",
        "offset": {
          "value": 24,
          "unit": "hour"
        }
      },
      "steps": [
        {
          "id": 67244,
          "stepNumber": 1,
          "recipient": "const",
          "template": "reminder",
          "sender": "Cal.com Notifications",
          "message": {
            "subject": "Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com",
            "html": "<p>Reminder for {EVENT_NAME}.</p>",
            "text": "Reminder for {EVENT_NAME}."
          },
          "action": "email_host",
          "email": 31214,
          "phone": "<string>",
          "phoneRequired": true,
          "includeCalendarEvent": true
        }
      ],
      "userId": 2313,
      "teamId": 4214321,
      "createdAt": "2024-05-12T10:00:00.000Z",
      "updatedAt": "2024-05-12T11:30:00.000Z"
    }
  ]
}

Headers

Authorization

string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

x-cal-secret-key

string

For platform customers - OAuth client secret key

x-cal-client-id

string

For platform customers - OAuth client ID

Path Parameters

teamId

number

required

workflowId

number

required

Body

application/json

name

string

Name of the workflow

Example:

"Platform Test Workflow"

activation

object

Activation settings for the workflow

Show child attributes

activation.isActiveOnAllEventTypes

boolean

default:false

required

Whether the workflow is active for all the event-types

Example:

false

activation.activeOnEventTypeIds

number[]

List of event-types IDs the workflow applies to, required if isActiveOnAllEventTypes is false

Example:

[698191]

trigger

object

Trigger configuration for the event-type workflow, allowed triggers are beforeEvent,eventCancelled,newEvent,afterEvent,rescheduleEvent,afterHostsCalVideoNoShow,afterGuestsCalVideoNoShow,bookingRejected,bookingRequested,bookingPaymentInitiated,bookingPaid,bookingNoShowUpdated

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12

Show child attributes

trigger.offset

object

required

Offset before/after the trigger time; required for BEFORE_EVENT, AFTER_EVENT, and FORM_SUBMITTED_NO_EVENT

Show child attributes

trigger.offset.value

number

required

Time value for offset before/after event trigger

Example:

24

trigger.offset.unit

object

required

Unit for the offset time

Example:

"hour"

trigger.type

enum<string>

default:beforeEvent

required

Trigger type for the workflow

Available options:

beforeEvent

Example:

"beforeEvent"

steps

object[]

Steps to execute as part of the event-type workflow, allowed steps are email_host,email_attendee,email_address,sms_attendee,sms_number,whatsapp_attendee,whatsapp_number,cal_ai_phone_call

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7

Show child attributes

steps.action

enum<string>

default:email_address

required

Action to perform, send an email to a specific email address

Available options:

email_host,

email_attendee,

email_address,

sms_attendee,

sms_number,

whatsapp_attendee,

whatsapp_number,

cal_ai_phone_call

Example:

"email_address"

steps.stepNumber

number

required

Step number in the workflow sequence

Example:

1

steps.recipient

enum<string>

required

Recipient type

Available options:

const,

attendee,

email,

phone_number

Example:

"attendee"

steps.template

enum<string>

required

Template type for the step

Available options:

reminder,

custom,

rescheduled,

completed,

rating,

cancelled

Example:

"reminder"

steps.sender

string

required

Displayed sender name.

steps.verifiedEmailId

number

required

Email address if recipient is EMAIL, required for action EMAIL_ADDRESS

Example:

"31214"

steps.includeCalendarEvent

object

required

Whether to include a calendar event in the notification, can be included with actions email_host, email_attendee, email_address

Example:

true

steps.message

object

required

Message content for this step

Show child attributes

steps.message.subject

string

required

Subject of the message

Example:

"Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com"

steps.message.html

string

required

HTML content of the message (used for Emails)

Example:

"<p>This is a reminder from {ORGANIZER} of {EVENT_NAME} to {ATTENDEE} starting here {LOCATION} {MEETING_URL} at {START_TIME_h:mma} {TIMEZONE}.</p>"

steps.id

number

Unique identifier of the step you want to update, if adding a new step do not provide this id

Example:

67244

Response

200 - application/json

status

enum<string>

required

Indicates the status of the response

Available options:

success,

error

Example:

"success"

data

object[]

required

workflow

Show child attributes

data.id

number

required

Unique identifier of the workflow

Example:

101

data.name

string

required

Name of the workflow

Example:

"Platform Test Workflow"

data.type

enum<string>

default:event-type

required

type of the workflow

Available options:

event-type

Example:

"event-type"

data.activation

object

required

Activation settings for the workflow

Show child attributes

data.activation.isActiveOnAllEventTypes

boolean

default:false

Whether the workflow is active for all event types associated with the team/user

Example:

false

data.activation.activeOnEventTypeIds

number[]

List of Event Type IDs the workflow is specifically active on (if not active on all)

Example:

[698191, 698192]

data.trigger

object

required

Trigger configuration

Show child attributes

data.trigger.type

enum<string>

required

Trigger type for the workflow

Available options:

beforeEvent,

eventCancelled,

newEvent,

afterEvent,

rescheduleEvent,

afterHostsCalVideoNoShow,

afterGuestsCalVideoNoShow,

bookingRejected,

bookingRequested,

bookingPaymentInitiated,

bookingPaid,

bookingNoShowUpdated

Example:

"beforeEvent"

data.trigger.offset

object

Offset details (present for BEFORE_EVENT/AFTER_EVENT)

Show child attributes

data.trigger.offset.value

number

required

Time value for offset

Example:

24

data.trigger.offset.unit

enum<string>

required

Unit for the offset time

Available options:

hour,

minute,

day

Example:

"hour"

data.steps

object[]

required

Steps comprising the workflow

Show child attributes

data.steps.id

number

required

Unique identifier of the step

Example:

67244

data.steps.stepNumber

number

required

Step number in the workflow sequence

Example:

1

data.steps.recipient

enum<string>

required

Intended recipient type

Available options:

const,

attendee,

email,

phone_number

Example:

"const"

data.steps.template

enum<string>

required

Template type used

Available options:

reminder,

custom,

rescheduled,

completed,

rating,

cancelled

Example:

"reminder"

data.steps.sender

string

required

Displayed sender name used for this step

Example:

"Cal.com Notifications"

data.steps.message

object

required

Message content for this step

Show child attributes

data.steps.message.subject

string

required

Subject of the message

Example:

"Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com"

data.steps.message.html

string

HTML content of the message

Example:

"<p>Reminder for {EVENT_NAME}.</p>"

data.steps.message.text

string

Text content of the message (used for SMS/WhatsApp)

Example:

"Reminder for {EVENT_NAME}."

data.steps.action

enum<string>

required

Action to perform

Available options:

email_host,

email_attendee,

email_address,

sms_attendee,

sms_number,

whatsapp_attendee,

whatsapp_number,

cal_ai_phone_call

Example:

"email_host"

data.steps.email

string

Verified Email if action is EMAIL_ADDRESS

Example:

31214

data.steps.phone

string

Verified Phone if action is SMS_NUMBER or WHATSAPP_NUMBER

data.steps.phoneRequired

boolean

default:false

whether or not the attendees are required to provide their phone numbers when booking

Example:

true

data.steps.includeCalendarEvent

object

Whether a calendar event (.ics) was included (for email actions)

Example:

true

data.userId

number

ID of the user who owns the workflow (if not team-owned)

Example:

2313

data.teamId

number

ID of the team owning the workflow

Example:

4214321

data.createdAt

object

Timestamp of creation

Example:

"2024-05-12T10:00:00.000Z"

data.updatedAt

object

Timestamp of last update

Example:

"2024-05-12T11:30:00.000Z"

Delete organization team workflow Get organization team workflow

⌘I

Getting Started

Platform / Managed Users

Platform / Webhooks

Orgs / Attributes

Orgs / Attributes / Options

Orgs / Bookings

Orgs / Delegation Credentials

Orgs / Memberships

Orgs / Roles

Orgs / Roles / Permissions

Orgs / Routing forms

Orgs / Schedules

Orgs / Teams

Orgs / Teams / Bookings

Orgs / Teams / Conferencing

Orgs / Teams / Event Types

Orgs / Teams / Event Types / Private Links

Orgs / Teams / Invite

Orgs / Teams / Memberships

Orgs / Teams / Roles

Orgs / Teams / Roles / Permissions

Orgs / Teams / Routing forms

Orgs / Teams / Routing forms / Responses

Orgs / Teams / Schedules

Orgs / Teams / Stripe

Orgs / Teams / Users / Schedules

Orgs / Teams / Workflows

Orgs / Users

Orgs / Users / Bookings

Orgs / Users / OOO

Orgs / Users / Schedules

Orgs / Webhooks

Api Keys

Bookings

Bookings / Guests

Cal Unified Calendars

Calendars

Conferencing

Destination Calendars

Event Types

Event Types / Webhooks

Event Types Private Links

Managed Orgs

Me

OAuth Clients

Organization Team Verified Resources

Routing forms

Schedules

Selected Calendars

Slots

Stripe

Teams

Teams / Event Types

Teams / Memberships

Teams / Schedules

Teams Verified Resources

Verified Resources

Webhooks

Headers

Path Parameters

Body

Response