Oneprofile Table Schedules API

openapi: 3.2.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: REST API reference for Oneprofile, the GTM data layer for your CRM. Manage tables, enrichments, and integrations. Authenticate with an API key to get started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: Reference | Oneprofile Table Schedules API
  version: 1.0.42765316646
tags:
- description: 'Endpoints for a table''s recurring import cadence: set it, pause it, and read the next fire times.'
  name: table-schedules
paths:
  /tables/{table_id}/schedule/:
    delete:
      description: 'The source stays attached; only the recurring run stops. A table with no schedule answers `count` 0, "Table had no schedule": nothing changed.'
      operationId: delete_table_schedule
      parameters:
      - in: path
        name: table_id
        required: true
        schema:
          format: uuid
          title: Table Id
          type: string
      - description: Report what would be deleted, and delete nothing.
        in: query
        name: dry_run
        required: false
        schema:
          default: false
          description: Report what would be deleted, and delete nothing.
          title: Dry Run
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessfullyDeletedResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Table not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Stop a table refreshing on a cadence
      tags:
      - table-schedules
    get:
      description: Read how often a table re-imports.
      operationId: get_table_schedule
      parameters:
      - in: path
        name: table_id
        required: true
        schema:
          format: uuid
          title: Table Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableScheduleSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Table has no schedule
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Get a table's refresh cadence
      tags:
      - table-schedules
    patch:
      description: 'Editing the cadence re-anchors it: ''every 3 days'' set today means three days from today. Resuming a paused schedule on its own does NOT: it keeps firing at the same time of day (or the same interval) the schedule was already on, just moved to the next upcoming occurrence, so a schedule left paused for a month neither fires the moment it comes back nor drifts to a new time.'
      operationId: update_table_schedule
      parameters:
      - in: path
        name: table_id
        required: true
        schema:
          format: uuid
          title: Table Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTableScheduleRequestSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableScheduleSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Table has no schedule
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Change a table's refresh cadence
      tags:
      - table-schedules
    put:
      description: 'Re-import on a cadence: from the connected tool that fills the table, or, for a table made from a subdomain search, by reading its domain again and adding the new subdomains. A table has one schedule: this makes it, or replaces the one it has with the cadence sent, and a paused schedule stays paused. The presets are calendar statements (monthly on the same date, quarterly in the same month) while `custom` is an interval counted from when you set it up.


        The response carries the next few fire times, so a cadence can be checked before it is left to run unattended.


        Turning on `delete_missing_rows` makes every scheduled run re-list the whole source: a changes-only fetch cannot tell a deleted record from an unchanged one, and treating the difference as deletion would empty the table. A table made from a subdomain search only ever adds rows, so it refuses `delete_missing_rows`.'
      operationId: set_table_schedule
      parameters:
      - in: path
        name: table_id
        required: true
        schema:
          format: uuid
          title: Table Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTableScheduleRequestSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableScheduleSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Table not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Set a table's refresh cadence
      tags:
      - table-schedules
components:
  schemas:
    UpdateTableScheduleRequestSchema:
      description: Change a table's cadence. Every field is optional.
      properties:
        delete_missing_rows:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Delete Missing Rows
        frequency:
          anyOf:
          - $ref: '#/components/schemas/TableScheduleFrequency'
          - type: 'null'
        hour:
          anyOf:
          - maximum: 23.0
            minimum: 0.0
            type: integer
          - type: 'null'
          title: Hour
        interval_unit:
          anyOf:
          - $ref: '#/components/schemas/TableScheduleIntervalUnit'
          - type: 'null'
        interval_value:
          anyOf:
          - exclusiveMinimum: 0.0
            maximum: 365.0
            type: integer
          - type: 'null'
          title: Interval Value
        minute:
          anyOf:
          - maximum: 59.0
            minimum: 0.0
            type: integer
          - type: 'null'
          title: Minute
        paused:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Paused
        time_zone:
          anyOf:
          - maxLength: 64
            type: string
          - type: 'null'
          title: Time Zone
      title: UpdateTableScheduleRequestSchema
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
      - detail
      title: ForbiddenResponse
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: boolean
          - items: {}
            type: array
          - additionalProperties: true
            type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: The location of the error. Always contains 1 or 2 elements. The first element is the type of location (e.g. 'body', 'query', 'path', 'header'). The second element is the name of the field that caused the error. If the error is not related to a specific field, the second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: The type of the error. Useful for frontend code to handle different types of errors.
          title: Type
          type: string
      required:
      - loc
      - msg
      - type
      - input
      title: UnprocessableEntityIssue
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
      - detail
      title: ServerErrorResponse
      type: object
    TableScheduleIntervalUnit:
      description: 'The unit a CUSTOM cadence counts in.


        HOURS is the only one with no time of day to honour: "every 6 hours at

        09:00" is two statements that cannot both be true. It anchors to the next

        occurrence of the chosen MINUTE instead, the same way the HOURLY preset

        keeps the minute and drops the hour.'
      enum:
      - hours
      - days
      - weeks
      - months
      title: TableScheduleIntervalUnit
      type: string
    TableScheduleSkipReason:
      description: 'Why a firing skipped starting an import instead of recording a run.


        Every case advances ``next_run_at`` the same as a real run does, so without

        this the schedule just quietly keeps ticking, and a user watching for their

        nightly refresh has nothing to look at but silence.'
      enum:
      - source_detached
      - run_in_progress
      - refresh_failed
      title: TableScheduleSkipReason
      type: string
    CreateTableScheduleRequestSchema:
      description: Set up a table's refresh cadence.
      properties:
        delete_missing_rows:
          default: false
          description: Delete rows whose records have gone from the source. Forces every scheduled run to re-list everything, and is capped per run so a provider outage cannot empty the table.
          title: Delete Missing Rows
          type: boolean
        frequency:
          $ref: '#/components/schemas/TableScheduleFrequency'
          description: A preset, or 'custom' for an interval.
        hour:
          default: 9
          description: Local hour to run at.
          maximum: 23.0
          minimum: 0.0
          title: Hour
          type: integer
        interval_unit:
          anyOf:
          - $ref: '#/components/schemas/TableScheduleIntervalUnit'
          - type: 'null'
          description: Required for a custom cadence.
        interval_value:
          anyOf:
          - exclusiveMinimum: 0.0
            maximum: 365.0
            type: integer
          - type: 'null'
          description: Required for a custom cadence.
          title: Interval Value
        minute:
          default: 0
          description: Local minute to run at.
          maximum: 59.0
          minimum: 0.0
          title: Minute
          type: integer
        time_zone:
          anyOf:
          - maxLength: 64
            type: string
          - type: 'null'
          description: IANA zone the time is in; defaults to UTC. An unknown zone falls back to UTC.
          title: Time Zone
      required:
      - frequency
      title: CreateTableScheduleRequestSchema
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: The detail of the error. This is the error message to show to the user. You should also use the issues field to show more detailed error messages per field. Use this field for a single liner error message.
          title: Detail
          type: string
        issues:
          description: The issues that caused the error. There can be multiple issues. Each issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
      - detail
      - issues
      title: UnprocessableEntityResponse
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
      - detail
      title: UnauthorizedResponse
      type: object
    TableScheduleSchema:
      description: A table's refresh cadence.
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        delete_missing_rows:
          description: Whether a scheduled run deletes rows whose records are gone from the source. Forces every scheduled run to re-list everything, since a changes-only fetch cannot tell a deleted record from an unchanged one.
          title: Delete Missing Rows
          type: boolean
        frequency:
          $ref: '#/components/schemas/TableScheduleFrequency'
        hour:
          description: Local hour the cadence runs at.
          title: Hour
          type: integer
        id:
          format: uuid
          title: Id
          type: string
        interval_unit:
          anyOf:
          - $ref: '#/components/schemas/TableScheduleIntervalUnit'
          - type: 'null'
        interval_value:
          anyOf:
          - type: integer
          - type: 'null'
          description: How many units apart, for a custom cadence.
          title: Interval Value
        last_skip_reason:
          anyOf:
          - $ref: '#/components/schemas/TableScheduleSkipReason'
          - type: 'null'
          description: Why the last firing skipped, alongside last_skipped_at.
        last_skipped_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: When a firing last skipped without starting a run; null if it never has.
          title: Last Skipped At
        minute:
          description: Local minute the cadence runs at.
          title: Minute
          type: integer
        next_run_at:
          format: date-time
          title: Next Run At
          type: string
        next_runs:
          description: The next few fire times, so a cadence can be checked before it is trusted.
          items:
            format: date-time
            type: string
          title: Next Runs
          type: array
        paused:
          title: Paused
          type: boolean
        table_id:
          format: uuid
          title: Table Id
          type: string
        time_zone:
          description: IANA zone the run time is expressed in.
          title: Time Zone
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
      required:
      - id
      - table_id
      - frequency
      - interval_value
      - interval_unit
      - time_zone
      - hour
      - minute
      - next_run_at
      - next_runs
      - paused
      - delete_missing_rows
      - last_skipped_at
      - last_skip_reason
      - created_at
      - updated_at
      title: TableScheduleSchema
      type: object
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
      - detail
      title: NotFoundResponse
      type: object
    TableScheduleFrequency:
      description: 'How often a table re-imports, in the vocabulary the settings panel offers.


        The presets are stored as cron because "the 8th of every month at 09:00" is

        a calendar statement that an interval cannot make: an interval of 30 days

        drifts off the date within a year. CUSTOM is the escape hatch for "every N

        days/weeks/months", which is an interval and drifts on purpose, anchored to

        when the user set it up.


        HOURLY is cron too, and it is the one preset that ignores the hour the user

        picked: "every hour at 09:00" is not a thing anyone means. The minute is

        kept, so an hourly refresh set at 09:20 runs at twenty past every hour, and

        a source that rate-limits is not hit by every table on the hour.'
      enum:
      - hourly
      - daily
      - weekly
      - monthly
      - quarterly
      - custom
      title: TableScheduleFrequency
      type: string
    SuccessfullyDeletedResponse:
      properties:
        count:
          default: 1
          description: The number of resources that were deleted.
          title: Count
          type: integer
        detail:
          description: The detail of why the resource was deleted.
          title: Detail
          type: string
      required:
      - detail
      title: SuccessfullyDeletedResponse
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http