> ## Documentation Index > Fetch the complete documentation index at: https://cal.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update organization routing form team workflow > Required membership role: `team admin`. PBAC permission: `workflow.update`. Learn more about API access control at https://cal.com/docs/api-reference/v2/access-control. If accessed using an OAuth access token, the `TEAM_WORKFLOW_WRITE` scope is required. ## OpenAPI ````yaml /api-reference/v2/openapi.json patch /v2/organizations/{orgId}/teams/{teamId}/workflows/{workflowId}/routing-form openapi: 3.0.0 info: title: Cal.com API v2 description: '' version: 1.0.0 contact: {} servers: [] security: [] tags: [] paths: /v2/organizations/{orgId}/teams/{teamId}/workflows/{workflowId}/routing-form: patch: tags: - Orgs / Teams / Workflows summary: Update organization routing form team workflow description: >- Required membership role: `team admin`. PBAC permission: `workflow.update`. Learn more about API access control at https://cal.com/docs/api-reference/v2/access-control. If accessed using an OAuth access token, the `TEAM_WORKFLOW_WRITE` scope is required. operationId: OrganizationTeamWorkflowsController_updateRoutingFormWorkflow parameters: - name: Authorization in: header description: >- For non-platform customers - value must be `Bearer ` where `` is api key prefixed with cal_ required: false schema: type: string - name: x-cal-secret-key in: header description: For platform customers - OAuth client secret key required: false schema: type: string - name: x-cal-client-id in: header description: For platform customers - OAuth client ID required: false schema: type: string - name: teamId required: true in: path schema: type: number - name: workflowId required: true in: path schema: type: number - name: orgId required: true in: path schema: type: number requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateFormWorkflowDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GetRoutingFormWorkflowOutput' components: schemas: UpdateFormWorkflowDto: type: object properties: name: type: string description: Name of the workflow example: Rounting-form Test Workflow trigger: description: >- Trigger configuration for the routing-form workflow, allowed triggers are formSubmitted,formSubmittedNoEvent oneOf: - $ref: '#/components/schemas/OnFormSubmittedTriggerDto' - $ref: '#/components/schemas/OnFormSubmittedNoEventTriggerDto' steps: type: array description: >- Steps to execute as part of the routing-form workflow, allowed steps are email_attendee,email_address,sms_attendee,sms_number items: oneOf: - $ref: '#/components/schemas/UpdateEmailAddressWorkflowStepDto' - $ref: '#/components/schemas/UpdateEmailAttendeeWorkflowStepDto' - $ref: '#/components/schemas/UpdatePhoneAttendeeWorkflowStepDto' - $ref: '#/components/schemas/UpdatePhoneNumberWorkflowStepDto' activation: $ref: '#/components/schemas/WorkflowFormActivationDto' GetRoutingFormWorkflowOutput: type: object properties: status: type: string description: Indicates the status of the response example: success enum: - success - error data: description: workflow type: array items: $ref: '#/components/schemas/RoutingFormWorkflowOutput' required: - status - data OnFormSubmittedTriggerDto: type: object properties: type: type: string default: formSubmitted enum: - formSubmitted description: Trigger type for the workflow example: formSubmitted required: - type OnFormSubmittedNoEventTriggerDto: type: object properties: offset: description: >- Offset before/after the trigger time; required for BEFORE_EVENT, AFTER_EVENT, and FORM_SUBMITTED_NO_EVENT allOf: - $ref: '#/components/schemas/WorkflowTriggerOffsetDto' type: type: string default: formSubmittedNoEvent enum: - formSubmittedNoEvent description: Trigger type for the workflow example: formSubmittedNoEvent required: - offset - type UpdateEmailAddressWorkflowStepDto: type: object properties: action: type: string enum: - email_host - email_attendee - email_address - sms_attendee - sms_number - whatsapp_attendee - whatsapp_number - cal_ai_phone_call default: email_address description: Action to perform, send an email to a specific email address example: email_address stepNumber: type: number description: Step number in the workflow sequence example: 1 recipient: type: string enum: - const - attendee - email - phone_number description: Recipient type example: attendee template: type: string enum: - reminder - custom - rescheduled - completed - rating - cancelled description: >- Template type for the step. Case-insensitive: uppercase values (e.g. `REMINDER`) are normalized to lowercase server-side for backwards compat. example: reminder sender: type: string description: Displayed sender name. autoTranslateEnabled: type: boolean description: >- Whether to enable auto-translation of the workflow step content for attendees. Only available for organizations. example: false default: false sourceLocale: enum: - ar - ca - de - es - eu - he - id - ja - lv - pl - ro - sr - th - vi - az - cs - el - es-419 - fi - hr - it - km - nl - pt - ru - sv - tr - zh-CN - bg - da - en - et - fr - hu - iw - ko - 'no' - pt-BR - sk - ta - uk - zh-TW - bn type: string description: >- The source locale of the workflow step content used for auto-translation (e.g. 'en'). Defaults to the user's locale. example: en verifiedEmailId: type: number description: >- Email address if recipient is EMAIL, required for action EMAIL_ADDRESS example: 31214 externalDocs: url: >- https://cal.com/docs/api-reference/v2/organization-team-verified-resources/verify-an-email-for-an-org-team includeCalendarEvent: type: boolean default: false description: >- Whether to include a calendar event in the notification, can be included with actions email_host, email_attendee, email_address example: true message: description: Message content for this step allOf: - $ref: '#/components/schemas/HtmlWorkflowMessageDto' id: type: number description: >- Unique identifier of the step you want to update, if adding a new step do not provide this id example: 67244 required: - action - stepNumber - recipient - template - sender - verifiedEmailId - includeCalendarEvent - message UpdateEmailAttendeeWorkflowStepDto: type: object properties: action: type: string enum: - email_host - email_attendee - email_address - sms_attendee - sms_number - whatsapp_attendee - whatsapp_number - cal_ai_phone_call default: email_attendee description: Action to perform, send an email to the attendees of the event example: email_attendee stepNumber: type: number description: Step number in the workflow sequence example: 1 recipient: type: string enum: - const - attendee - email - phone_number description: Recipient type example: attendee template: type: string enum: - reminder - custom - rescheduled - completed - rating - cancelled description: >- Template type for the step. Case-insensitive: uppercase values (e.g. `REMINDER`) are normalized to lowercase server-side for backwards compat. example: reminder sender: type: string description: Displayed sender name. autoTranslateEnabled: type: boolean description: >- Whether to enable auto-translation of the workflow step content for attendees. Only available for organizations. example: false default: false sourceLocale: enum: - ar - ca - de - es - eu - he - id - ja - lv - pl - ro - sr - th - vi - az - cs - el - es-419 - fi - hr - it - km - nl - pt - ru - sv - tr - zh-CN - bg - da - en - et - fr - hu - iw - ko - 'no' - pt-BR - sk - ta - uk - zh-TW - bn type: string description: >- The source locale of the workflow step content used for auto-translation (e.g. 'en'). Defaults to the user's locale. example: en includeCalendarEvent: type: boolean default: false description: >- Whether to include a calendar event in the notification, can be included with actions email_host, email_attendee, email_address example: true message: description: Message content for this step allOf: - $ref: '#/components/schemas/HtmlWorkflowMessageDto' id: type: number description: >- Unique identifier of the step you want to update, if adding a new step do not provide this id example: 67244 required: - action - stepNumber - recipient - template - sender - includeCalendarEvent - message UpdatePhoneAttendeeWorkflowStepDto: type: object properties: action: type: string enum: - email_host - email_attendee - email_address - sms_attendee - sms_number - whatsapp_attendee - whatsapp_number - cal_ai_phone_call default: sms_attendee description: >- Action to perform, send a text message to the phone numbers of the attendees example: sms_attendee stepNumber: type: number description: Step number in the workflow sequence example: 1 recipient: type: string enum: - const - attendee - email - phone_number description: Recipient type example: attendee template: type: string enum: - reminder - custom - rescheduled - completed - rating - cancelled description: >- Template type for the step. Case-insensitive: uppercase values (e.g. `REMINDER`) are normalized to lowercase server-side for backwards compat. example: reminder sender: type: string description: Displayed sender name. autoTranslateEnabled: type: boolean description: >- Whether to enable auto-translation of the workflow step content for attendees. Only available for organizations. example: false default: false sourceLocale: enum: - ar - ca - de - es - eu - he - id - ja - lv - pl - ro - sr - th - vi - az - cs - el - es-419 - fi - hr - it - km - nl - pt - ru - sv - tr - zh-CN - bg - da - en - et - fr - hu - iw - ko - 'no' - pt-BR - sk - ta - uk - zh-TW - bn type: string description: >- The source locale of the workflow step content used for auto-translation (e.g. 'en'). Defaults to the user's locale. example: en message: description: Message content for this step allOf: - $ref: '#/components/schemas/TextWorkflowMessageDto' phoneRequired: type: boolean description: >- whether or not the attendees are required to provide their phone numbers when booking example: true default: false id: type: number description: >- Unique identifier of the step you want to update, if adding a new step do not provide this id example: 67244 required: - action - stepNumber - recipient - template - sender - message UpdatePhoneNumberWorkflowStepDto: type: object properties: action: type: string enum: - email_host - email_attendee - email_address - sms_attendee - sms_number - whatsapp_attendee - whatsapp_number - cal_ai_phone_call default: sms_number description: Action to perform, send a text message to a specific phone number example: sms_number stepNumber: type: number description: Step number in the workflow sequence example: 1 recipient: type: string enum: - const - attendee - email - phone_number description: Recipient type example: attendee template: type: string enum: - reminder - custom - rescheduled - completed - rating - cancelled description: >- Template type for the step. Case-insensitive: uppercase values (e.g. `REMINDER`) are normalized to lowercase server-side for backwards compat. example: reminder sender: type: string description: Displayed sender name. autoTranslateEnabled: type: boolean description: >- Whether to enable auto-translation of the workflow step content for attendees. Only available for organizations. example: false default: false sourceLocale: enum: - ar - ca - de - es - eu - he - id - ja - lv - pl - ro - sr - th - vi - az - cs - el - es-419 - fi - hr - it - km - nl - pt - ru - sv - tr - zh-CN - bg - da - en - et - fr - hu - iw - ko - 'no' - pt-BR - sk - ta - uk - zh-TW - bn type: string description: >- The source locale of the workflow step content used for auto-translation (e.g. 'en'). Defaults to the user's locale. example: en verifiedPhoneId: type: number description: >- Phone number if recipient is PHONE_NUMBER, required for actions SMS_NUMBER and WHATSAPP_NUMBER example: 3243434 externalDocs: url: >- https://cal.com/docs/api-reference/v2/organization-team-verified-resources/verify-a-phone-number-for-an-org-team message: description: Message content for this step allOf: - $ref: '#/components/schemas/TextWorkflowMessageDto' id: type: number description: >- Unique identifier of the step you want to update, if adding a new step do not provide this id example: 67244 required: - action - stepNumber - recipient - template - sender - verifiedPhoneId - message WorkflowFormActivationDto: type: object properties: isActiveOnAllRoutingForms: type: boolean description: Whether the workflow is active for all the routing forms example: false activeOnRoutingFormIds: description: List of routing form IDs the workflow applies to example: - abd1-123edf-a213d-123dfwf type: array items: type: number required: - isActiveOnAllRoutingForms RoutingFormWorkflowOutput: type: object properties: id: type: number description: Unique identifier of the workflow example: 101 name: type: string description: Name of the workflow example: Platform Test Workflow userId: type: number description: ID of the user who owns the workflow (if not team-owned) example: 2313 teamId: type: number description: ID of the team owning the workflow example: 4214321 createdAt: type: string description: Timestamp of creation example: '2024-05-12T10:00:00.000Z' format: date-time updatedAt: type: string description: Timestamp of last update example: '2024-05-12T11:30:00.000Z' format: date-time type: type: string enum: - routing-form description: type of the workflow example: routing-form default: routing-form activation: description: Activation settings for the workflow allOf: - $ref: '#/components/schemas/RoutingFormWorkflowActivationOutputDto' trigger: description: Trigger configuration allOf: - $ref: '#/components/schemas/RoutingFormWorkflowTriggerOutputDto' steps: description: Steps comprising the workflow type: array items: $ref: '#/components/schemas/RoutingFormWorkflowStepOutputDto' required: - id - name - type - activation - trigger - steps WorkflowTriggerOffsetDto: type: object properties: value: type: number description: Time value for offset before/after event trigger example: 24 unit: type: string description: Unit for the offset time example: hour enum: - hour - minute - day required: - value - unit HtmlWorkflowMessageDto: type: object properties: subject: type: string description: Subject of the message example: >- Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com html: type: string description: HTML content of the message (used for Emails) example: >-

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

required: - subject - html TextWorkflowMessageDto: type: object properties: subject: type: string description: Subject of the message example: >- Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com text: type: string description: Text content of the message (used for SMS) example: >- This is a reminder message from {ORGANIZER} of {EVENT_NAME} to {ATTENDEE} starting here {LOCATION} {MEETING_URL} at {START_TIME_h:mma} {TIMEZONE}. required: - subject - text RoutingFormWorkflowActivationOutputDto: type: object properties: isActiveOnAllRoutingForms: type: boolean default: false description: >- Whether the workflow is active for all routing forms associated with the team/user example: false activeOnRoutingFormIds: description: >- List of Event Type IDs the workflow is specifically active on (if not active on all) example: - 5cacdec7-1234-6e1b-78d9-7bcda8a1b332 type: array items: type: string RoutingFormWorkflowTriggerOutputDto: type: object properties: type: type: string description: Trigger type for the workflow example: formSubmitted enum: - formSubmitted - formSubmittedNoEvent offset: description: >- Offset details (present for BEFORE_EVENT/AFTER_EVENT/FORM_SUBMITTED_NO_EVENT) allOf: - $ref: '#/components/schemas/WorkflowTriggerOffsetOutputDto' required: - type RoutingFormWorkflowStepOutputDto: type: object properties: id: type: number description: Unique identifier of the step example: 67244 stepNumber: type: number description: Step number in the workflow sequence example: 1 recipient: type: string description: Intended recipient type example: const enum: - const - attendee - email - phone_number email: type: string description: Verified email address if action is EMAIL_ADDRESS example: notifications@example.com phone: type: string description: Verified Phone if action is SMS_NUMBER or WHATSAPP_NUMBER phoneRequired: type: boolean description: >- whether or not the attendees are required to provide their phone numbers when booking example: true default: false template: type: string description: Template type used example: reminder enum: - reminder - custom - rescheduled - completed - rating - cancelled includeCalendarEvent: type: boolean default: false description: Whether a calendar event (.ics) was included (for email actions) example: true sender: type: string description: Displayed sender name used for this step example: Cal.com Notifications message: description: Message content for this step allOf: - $ref: '#/components/schemas/WorkflowMessageOutputDto' autoTranslateEnabled: type: boolean description: >- Whether auto-translation of the workflow step content for attendees is enabled. Only available for organizations. example: false default: false sourceLocale: nullable: true type: string description: >- The source locale of the workflow step content used for auto-translation (e.g. 'en'). example: en enum: - ar - ca - de - es - eu - he - id - ja - lv - pl - ro - sr - th - vi - az - cs - el - es-419 - fi - hr - it - km - nl - pt - ru - sv - tr - zh-CN - bg - da - en - et - fr - hu - iw - ko - 'no' - pt-BR - sk - ta - uk - zh-TW - bn action: type: string description: Action to perform example: email_host enum: - email_attendee - email_address - sms_attendee - sms_number required: - id - stepNumber - recipient - template - sender - message - action WorkflowTriggerOffsetOutputDto: type: object properties: value: type: number description: Time value for offset example: 24 unit: type: string description: Unit for the offset time example: hour enum: - hour - minute - day required: - value - unit WorkflowMessageOutputDto: type: object properties: subject: type: string description: Subject of the message example: >- Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com html: type: string description: HTML content of the message example:

Reminder for {EVENT_NAME}.

text: type: string description: Text content of the message (used for SMS/WhatsApp) example: Reminder for {EVENT_NAME}. required: - subject ````