@contio/partner-sdk - v1.8.0
    Preparing search index...

    Interface RequestOptions

    Options that can be passed to individual API requests

    interface RequestOptions {
        idempotencyKey?: string;
        timezone?: string;
    }
    Index

    Properties

    idempotencyKey?: string

    Idempotency key for safe retries on mutation requests (POST, PUT, PATCH, DELETE). The API deduplicates requests sharing the same key within a 24-hour window — the first request executes normally and its response is stored; subsequent retries with the same key replay the stored response without re-executing.

    • Ignored on GET/HEAD requests (they are naturally idempotent).
    • Ignored on multipart/file-upload endpoints.
    • Must be ≤255 printable ASCII characters.
    • A conflict (another request with the same key still in flight) returns a 409 error whose ContioAPIError.retryAfter field indicates when to retry.

    Use crypto.randomUUID() to generate a unique key per logical operation and reuse that same key on every retry of that operation.

    timezone?: string

    Override the default timezone for this request. Can be an IANA identifier (e.g., 'America/New_York') or a timezone abbreviation (e.g., 'EST', 'PST').