> ## Documentation Index
> Fetch the complete documentation index at: https://docs.teamfollowup.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the public API base URL: https://api.teamfollowup.ai/api.
> Authenticate public API requests with Authorization: Bearer YOUR_API_KEY.
> Use product-owned terms: agents, calls, campaigns, contacts, phone numbers, billing, and configuration.

# Update campaign schedule

> Update a campaign Power Dialer schedule. Include `campaignId` and `locationId` when saving from a campaign-bound workspace. Customer role: `agency_admin`.

Required API key scope: `power_dialer:write`.



## OpenAPI

````yaml /openapi.yaml put /api/power-dialer/cadences/{id}
openapi: 3.1.0
info:
  title: TFUAI Server API
  version: 1.0.0
  description: >-
    API reference for the TFUAI SaaS server.


    All published endpoints are mounted under `/api`. Responses use a standard
    envelope: `{ "success": true, ... }` on success and `{ "success": false,
    "error": "..." }` on failure.


    Product API modules are being launched module by module. This spec currently
    exposes only contracted public modules.


    Authenticate public API requests with an API key in the `Authorization`
    header: `Authorization: Bearer YOUR_API_KEY`.
servers:
  - url: https://api.teamfollowup.ai
    description: Production API origin. Public API paths are under /api.
  - url: https://devapi.teamfollowup.ai
    description: Development API origin. Public API paths are under /api.
security: []
tags:
  - name: Agents
    description: Manage voice agents, campaigns, workflows, and outcomes.
  - name: Analytics
    description: >-
      Minimal, non-billing performance summary: volume, conversion, and pickup
      metrics.
  - name: Calls
    description: Review calls, test runs, and execution history.
  - name: Campaign Workflows
    description: >-
      What runs after a call lands: for each outcome (booked, opted out, asked
      for a callback…), an ordered chain of actions — tag the contact, move a
      pipeline stage, send an SMS, book an appointment. Stored as a graph:
      `nodes` are the actions, `edges` say what follows what, and
      `dispositionEntries` maps each outcome to the node its chain starts at.


      **Pick the narrowest endpoint that does the job.**


      | To | Call | |

      | --- | --- | --- |

      | See what fires per outcome | `GET .../workflow/digest` | Reads as plain
      text, no graph walking |

      | Add steps to an outcome | `POST .../outcomes/{outcome}/nodes` | Server
      derives node ids, edge ids, handles, layout |

      | Change a message, tag or setting | `PATCH .../workflow` | Merges;
      carries no graph, so it cannot damage one |

      | Remove one step | `DELETE .../nodes/{nodeId}` | Also re-links the chain
      around it |

      | Author or replace the whole graph | `PUT .../workflow` | Replaces
      everything you send |


      `PUT` is the only one that can re-wire, position nodes, build an `if`,
      save an unconfigured draft, or copy a whole workflow — and the only one
      that can overwrite a change someone else made after you read it. Use it
      when you are genuinely authoring the graph, and send `expectedVersion`
      when you do. For everything else the narrower endpoints are both easier
      and safer.
  - name: Contacts
    description: Contact list, filters, contact call history, and do-not-call actions.
  - name: GHL
    description: CRM variables and contact helpers used by agent and campaign setup flows.
  - name: Phone Numbers
    description: >-
      Caller ID pool, number search, assignment, movement, and release
      endpoints.
  - name: Power Dialer
    description: >-
      Power Dialer queue, lead cadence, callback, parked lead, and campaign
      schedule endpoints.
  - name: Projects
    description: >-
      Project management endpoints: list, update, disconnect, configure project
      campaigns, and validate setup.
  - name: Skills and Tools
    description: Manage reusable agent behaviors and in-call tool descriptions.
  - name: Voices
    description: Voice catalogue endpoints for choosing the voice used by an agent.
paths:
  /api/power-dialer/cadences/{id}:
    put:
      tags:
        - Power Dialer
      summary: Update campaign schedule
      description: >-
        Update a campaign Power Dialer schedule. Include `campaignId` and
        `locationId` when saving from a campaign-bound workspace. Customer role:
        `agency_admin`.


        Required API key scope: `power_dialer:write`.
      operationId: update-cadence
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
          description: Schedule id.
          example: cadence_123
      requestBody:
        required: true
        description: Schedule update payload.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PowerDialerCadenceUpdateRequest'
            examples:
              default:
                value:
                  cadenceName: Three-touch follow-up
                  schedule:
                    - day: 1
                      hour: 9
                      minute: 30
                      period: AM
                      doubleDial: true
                      call:
                        enabled: true
                      additionalActions:
                        - type: sms
                          body: >-
                            Hi Alex, are you still interested in booking a
                            consultation?
                          delaySeconds: 0
                          jitterSeconds: 60
                    - day: 3
                      hour: 10
                      minute: 0
                      period: AM
                      call:
                        enabled: false
                      additionalActions:
                        - type: sms
                          body: Following up again about your consultation.
                  activeDays:
                    - 1
                    - 2
                    - 3
                    - 4
                    - 5
                  campaignId: campaign_speed_to_lead_123
                  locationId: loc_9f7a123
      responses:
        '200':
          description: Updated schedule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerCadenceUpdateResponse'
              examples:
                default:
                  value:
                    success: true
                    data:
                      _id: cadence_123
                      cadenceName: Three-touch follow-up
                      isDefault: false
                      locationIds:
                        - loc_9f7a123
                      campaignIds:
                        - campaign_speed_to_lead_123
                      activeDays:
                        - 1
                        - 2
                        - 3
                        - 4
                        - 5
                      active: true
                      schedule:
                        - day: 1
                          hour: 9
                          minute: 30
                          period: AM
                          doubleDial: true
                          call:
                            enabled: true
                          additionalActions:
                            - type: sms
                              body: >-
                                Hi Alex, are you still interested in booking a
                                consultation?
                              delaySeconds: 0
                              jitterSeconds: 60
                      createdAt: '2026-07-08T16:10:00.000Z'
                      updatedAt: '2026-07-08T16:45:00.000Z'
                    reorder:
                      remapped: 0
                      movedSteps: 0
                      removed: 0
                      deletedSteps: 0
        '400':
          description: Validation failed or the request is malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: cadenceStep query parameter is required
        '401':
          description: Missing or invalid authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Unauthorized
        '403':
          description: >-
            Authenticated but not permitted to access the requested project or
            schedule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: You do not have access to this project
        '404':
          description: Resource not found or not visible to the caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Schedule not found.
        '409':
          description: >-
            The requested schedule change conflicts with the current campaign
            state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: >-
                      This schedule is shared by more than one campaign or
                      project. Clone it and edit your copy.
        '422':
          description: The request is valid JSON but needs an explicit safety confirmation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: >-
                      This change re-sequences touchpoints and remaps in-flight
                      leads. Re-send with confirmReorder:true.
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: TooManyRequests
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Unexpected server error.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --request PUT \
              --url https://api.teamfollowup.ai/api/power-dialer/cadences/{id} \
              --header 'Authorization: Bearer YOUR_API_KEY' \
              --header 'Content-Type: application/json' \
              --data '{
              "cadenceName": "Three-touch follow-up",
              "schedule": [
                {
                  "day": 1,
                  "hour": 9,
                  "minute": 30,
                  "period": "AM",
                  "doubleDial": true,
                  "call": {
                    "enabled": true
                  },
                  "additionalActions": [
                    {
                      "type": "sms",
                      "body": "Hi Alex, are you still interested in booking a consultation?",
                      "delaySeconds": 0,
                      "jitterSeconds": 60
                    }
                  ]
                },
                {
                  "day": 3,
                  "hour": 10,
                  "minute": 0,
                  "period": "AM",
                  "call": {
                    "enabled": false
                  },
                  "additionalActions": [
                    {
                      "type": "sms",
                      "body": "Following up again about your consultation."
                    }
                  ]
                }
              ],
              "activeDays": [
                1,
                2,
                3,
                4,
                5
              ],
              "campaignId": "campaign_speed_to_lead_123",
              "locationId": "loc_9f7a123"
            }'
components:
  schemas:
    PowerDialerCadenceUpdateRequest:
      type: object
      additionalProperties: {}
      minProperties: 1
      properties:
        cadenceName:
          type: string
          example: Three-touch follow-up
        schedule:
          type: array
          items:
            $ref: '#/components/schemas/PowerDialerScheduleEntry'
        activeDays:
          type: array
          items:
            type: integer
            minimum: 0
            maximum: 6
          example:
            - 1
            - 2
            - 3
            - 4
            - 5
        mode:
          type: string
          enum:
            - appointment_reminder
          example: appointment_reminder
        stepOrder:
          type: array
          items:
            type:
              - integer
              - 'null'
          example:
            - 0
            - null
        deletions:
          type: array
          items:
            $ref: '#/components/schemas/PowerDialerStepDeletion'
        confirmReorder:
          type: boolean
          example: true
        allowEmpty:
          type: boolean
          example: false
        campaignId:
          type: string
          example: campaign_speed_to_lead_123
        locationId:
          type: string
          example: loc_9f7a123
    PowerDialerCadenceUpdateResponse:
      type: object
      additionalProperties: {}
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/PowerDialerCadence'
        reorder:
          type: object
          additionalProperties: false
          required:
            - remapped
            - movedSteps
            - removed
            - deletedSteps
          properties:
            remapped:
              type: integer
              example: 3
            movedSteps:
              type: integer
              example: 1
            removed:
              type: integer
              example: 0
            deletedSteps:
              type: integer
              example: 0
    PowerDialerErrorResponse:
      type: object
      additionalProperties: {}
      required:
        - success
        - error
      properties:
        success:
          type: boolean
        error:
          type: string
          example: You do not have access to this project
        code:
          type: string
          example: FORBIDDEN
        message:
          type: string
          example: You do not have access to this project
    PowerDialerScheduleEntry:
      oneOf:
        - $ref: '#/components/schemas/PowerDialerScheduleForwardEntry'
        - $ref: '#/components/schemas/PowerDialerScheduleReminderEntry'
      description: >-
        A single touchpoint in a cadence. Forward cadences use clock-time
        entries (PowerDialerScheduleForwardEntry); appointment_reminder cadences
        use appointment-anchored entries (PowerDialerScheduleReminderEntry).
    PowerDialerStepDeletion:
      type: object
      additionalProperties: false
      required:
        - step
        - leads
      properties:
        step:
          type: integer
          minimum: 0
          example: 1
        leads:
          type: string
          enum:
            - advance
            - remove
          example: advance
    PowerDialerCadence:
      type: object
      additionalProperties: {}
      required:
        - _id
        - cadenceName
        - isDefault
        - locationIds
        - campaignIds
        - activeDays
        - active
        - schedule
      properties:
        _id:
          type: string
          example: cadence_123
        cadenceName:
          type: string
          example: Three-touch follow-up
        isDefault:
          type: boolean
          example: false
        locationIds:
          type: array
          items:
            type: string
          example:
            - loc_9f7a123
        campaignIds:
          type: array
          items:
            type: string
          example:
            - campaign_speed_to_lead_123
        activeDays:
          type: array
          items:
            type: integer
            minimum: 0
            maximum: 6
          example:
            - 1
            - 2
            - 3
            - 4
            - 5
        active:
          type: boolean
          example: true
        stepCount:
          type: integer
          minimum: 0
          description: Number of touchpoints in the schedule.
          example: 3
        schedule:
          type: array
          items:
            $ref: '#/components/schemas/PowerDialerScheduleEntry'
        mode:
          type: string
          enum:
            - appointment_reminder
          example: appointment_reminder
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-07-08T16:10:00.000Z'
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-07-08T16:30:00.000Z'
    PowerDialerScheduleForwardEntry:
      type: object
      additionalProperties: {}
      required:
        - day
        - hour
        - minute
      description: 'A clock-time touchpoint: dial on a given weekday at a given time.'
      properties:
        day:
          type: integer
          minimum: 0
          example: 1
        hour:
          type: integer
          minimum: 1
          maximum: 12
          example: 9
        minute:
          type: integer
          minimum: 0
          maximum: 59
          example: 30
        period:
          type: string
          enum:
            - AM
            - PM
          description: AM or PM. Defaults to AM when omitted.
          example: AM
        doubleDial:
          type: boolean
          example: true
        call:
          type: object
          additionalProperties: false
          properties:
            enabled:
              type: boolean
              example: true
        additionalActions:
          type: array
          items:
            $ref: '#/components/schemas/PowerDialerScheduleAction'
    PowerDialerScheduleReminderEntry:
      type: object
      additionalProperties: {}
      required:
        - minutesBeforeAppt
      description: >-
        An appointment-anchored touchpoint for an appointment_reminder cadence:
        dial a fixed lead time before the booked appointment. Send
        minutesBeforeAppt; hoursBeforeAppt and daysBeforeAppt are also accepted
        and folded into minutes. Do not send day/hour/period.
      properties:
        minutesBeforeAppt:
          type: integer
          minimum: 1
          example: 1440
        doubleDial:
          type: boolean
          example: true
        call:
          type: object
          additionalProperties: false
          properties:
            enabled:
              type: boolean
              example: true
        additionalActions:
          type: array
          items:
            $ref: '#/components/schemas/PowerDialerScheduleAction'
    PowerDialerScheduleAction:
      type: object
      additionalProperties: {}
      required:
        - type
      description: >-
        A side effect the dialer runs when a touchpoint advances on no outcome,
        whether the call was unanswered or answered without an actionable
        outcome. `sms`/`email` carry exactly one of `body`/`snippetId`;
        `add-tag` carries `tags`; `move-stage` carries `pipelineId`+`stageId`.
      properties:
        type:
          type: string
          enum:
            - sms
            - email
            - add-tag
            - move-stage
          example: sms
        body:
          type: string
          example: Hi Alex, are you still interested in booking a consultation?
        snippetId:
          type: string
          example: snippet_follow_up_1
        subject:
          type: string
          example: Following up
        tags:
          type: array
          items:
            type: string
          description: Tags applied to the contact (add-tag actions).
          example:
            - no-answer-followup
        pipelineId:
          type: string
          description: Target pipeline id (move-stage actions).
          example: pipeline_123
        stageId:
          type: string
          description: Target stage id (move-stage actions).
          example: stage_456
        delaySeconds:
          type: integer
          minimum: 0
          example: 0
        jitterSeconds:
          type: integer
          minimum: 0
          example: 60
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.'

````