Skip to content

API reference

SiteChange ​

Type: object, no additional properties

  • access_state (required): string, possible values: "ok", "paused", "detached"

    Reconciled on every feed call, before paging. Access changes receive fresh sequence values; restored access emits current content again.

  • action (required): string, possible values: "upsert", "tombstone"

    upsert: create or update from episode. tombstone: apply the reason; detached and paused posts are kept.

  • changed_at (required): string, format: date-time, pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

  • episode (required): SiteChangeEpisode | null

  • episode_id (required): string, format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

  • podcast_id (required): string, format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

  • post (required): object, no additional properties

    The post this site last reported for the episode.

    • post_url (required): string | null
    • state (required): string | null, possible values: "queued", "scheduled", "published", "draft", "trashed"
    • wp_post_id (required): integer | null, minimum: -9007199254740991, maximum: 9007199254740991
  • reason (required): string | null, possible values: "deleted", "removed", "unpublished", "access_removed", "plan_or_policy"

    Tombstones: deleted moves to the bin; removed or unpublished moves to draft; access_removed detaches and keeps the post with No longer synced from show.fm; plan_or_policy pauses and leaves the post unchanged until access returns.

  • seq (required): integer, minimum: -9007199254740991, maximum: 9007199254740991

Was this page helpful?