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

# Reschedule campaign

> Moves the start of a launched campaign that is still waiting for it. Set `scheduledAt` to a later or earlier time, or to `null` to start now. The response returns the campaign with its new `scheduledAt`; sending the current start time again changes nothing. A suspended team is refused with `403 bansafe_org_suspended`. `409` means the campaign has already started, is finished or being stopped, or was never launched; launch a draft with `scheduledAt` instead.

Requires `campaigns:manage`. Project tokens only access resources in their own project.



## OpenAPI

````yaml api-reference/features/engage-at-scale.json POST /platform/campaigns/{campaignId}/reschedule
openapi: 3.0.3
info:
  title: Engage at scale API methods
  version: 1.0.0
  description: >-
    Task-focused engage at scale methods across supported Polymorfa connection
    types.
servers: []
security: []
paths:
  /platform/campaigns/{campaignId}/reschedule:
    post:
      tags:
        - Campaigns
      summary: Reschedule campaign
      description: >-
        Moves the start of a launched campaign that is still waiting for it. Set
        `scheduledAt` to a later or earlier time, or to `null` to start now. The
        response returns the campaign with its new `scheduledAt`; sending the
        current start time again changes nothing. A suspended team is refused
        with `403 bansafe_org_suspended`. `409` means the campaign has already
        started, is finished or being stopped, or was never launched; launch a
        draft with `scheduledAt` instead.


        Requires `campaigns:manage`. Project tokens only access resources in
        their own project.
      operationId: managementReschedulePlatformCampaign
      parameters:
        - name: campaignId
          in: path
          required: true
          schema:
            type: string
          description: Identifier for the campaign.
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Optional unique key, 1 to 255 bytes, that makes this request safe to
            retry for 24 hours. A retry with the same key, credential,
            `Polymorfa-Version` and request never runs it again: it returns `409
            idempotency_completed` when the original succeeded, or the original
            server error. Reusing the key for a different request returns `409
            idempotency_conflict`; a retry while the original is still running
            returns `409 idempotency_in_progress`, and a retry after an
            unrecorded outcome returns `409 idempotency_outcome_unknown`.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | String length | `1` through `255` characters |
          schema:
            type: string
            minLength: 1
            maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/management__ReschedulePlatformCampaignRequest
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Stable request correlation identifier.
            Polymorfa-Version:
              schema:
                type: string
              description: API version applied to this response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  data:
                    type: object
                    additionalProperties: true
                    required:
                      - id
                      - status
                      - operationId
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: |-
                          Identifier for this resource.

                          <!-- polymorfa-input-table -->
                          **Value constraints**
                          | Constraint | Accepted input |
                          | --- | --- |
                          | Format | `uuid` |
                      status:
                        type: string
                        enum:
                          - draft
                          - running
                          - paused
                          - cancelling
                          - cancelled
                          - completed
                          - failed
                          - archived
                        description: |-
                          Current status of this resource or operation.

                          <!-- polymorfa-input-table -->
                          **Allowed values**
                          | Value | Meaning |
                          | --- | --- |
                          | `draft` | Draft. |
                          | `running` | Running. |
                          | `paused` | Paused. |
                          | `cancelling` | Cancelling. |
                          | `cancelled` | Cancelled. |
                          | `completed` | Completed. |
                          | `failed` | Failed. |
                          | `archived` | Archived. |
                      operationId:
                        type: string
                        format: uuid
                        description: |-
                          The operation that carries this lifecycle action.

                          <!-- polymorfa-input-table -->
                          **Value constraints**
                          | Constraint | Accepted input |
                          | --- | --- |
                          | Format | `uuid` |
                    description: Structured data carried by this object.
                required:
                  - data
        '400':
          $ref: '#/components/responses/management__BadRequest'
        '401':
          $ref: '#/components/responses/management__Unauthorized'
        '403':
          $ref: '#/components/responses/management__Forbidden'
        '404':
          $ref: '#/components/responses/management__NotFound'
        '409':
          $ref: '#/components/responses/management__Conflict'
      security:
        - management__ApiKeyAuth: []
      servers:
        - url: https://api.polymorfa.com
components:
  schemas:
    management__ReschedulePlatformCampaignRequest:
      type: object
      additionalProperties: false
      properties:
        scheduledAt:
          type: integer
          minimum: 1
          maximum: 8640000000000000
          nullable: true
          description: >-
            The new start time in Unix milliseconds. `null`, or a time that is
            not in the future, starts the campaign now.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `integer`; Numeric value: `1` through
            `8640000000000000` (inclusive) |

            | Alternative 2 | `null` |


            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Numeric value | `1` through `8640000000000000` (inclusive) |
        projectId:
          type: string
          format: uuid
          description: >-
            Required when using a team API key. Project tokens derive the
            project from the credential.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Format | `uuid` |
      required:
        - scheduledAt
    management__ErrorEnvelope:
      type: object
      required:
        - error
        - data
        - docs
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - upstream_error
              description: |-
                Type discriminator for this object.

                <!-- polymorfa-input-table -->
                **Allowed values**
                | Value | Meaning |
                | --- | --- |
                | `invalid_request_error` | Invalid request error. |
                | `authentication_error` | Authentication error. |
                | `permission_error` | Permission error. |
                | `conflict_error` | Conflict error. |
                | `rate_limit_error` | Rate limit error. |
                | `api_error` | Api error. |
                | `upstream_error` | Upstream error. |
            code:
              type: string
              description: Stable failure code. Use this value for programmatic handling.
            message:
              type: string
              description: Safe explanation of the failure.
            param:
              type: string
              nullable: true
              description: |-
                Invalid request field, or null when no field applies.

                <!-- polymorfa-input-table -->
                **Accepted alternatives**
                | Alternative | Accepted input |
                | --- | --- |
                | Alternative 1 | Type: `string` |
                | Alternative 2 | `null` |
            request_id:
              type: string
              description: >-
                Matches the X-Request-Id response header. Include it when you
                contact support.
            request_log_url:
              type: string
              format: uri
              description: >-
                Console page that shows this request. Returned only to
                organization and project credentials whose request was logged.


                <!-- polymorfa-input-table -->

                **Value constraints**

                | Constraint | Accepted input |

                | --- | --- |

                | Format | `uri` |
          description: Error details returned when the operation fails.
        data:
          type: string
          nullable: true
          enum:
            - null
          description: |-
            Always null for a failed request.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `null` | Null. |

            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        docs:
          type: string
          format: uri
          description: |-
            Documentation link to this failure code.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
  responses:
    management__BadRequest:
      description: A path, query, or request-body value did not pass validation.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Unauthorized:
      description: Missing/invalid credential for this audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Forbidden:
      description: Authenticated but lacks the required scope/role/audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__NotFound:
      description: >-
        The requested resource was not found inside the authenticated team or
        project scope.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Conflict:
      description: The request conflicts with the resource's current state.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
  securitySchemes:
    management__ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Send your team API key or project token as `Authorization: Bearer
        <token>`. The credential must have the required permissions. Project
        tokens can access only their own project.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.