Skip to content
Open Podcast API

postSync

POST
/api/v1/sync
curl --request POST \
  --url https://example.com/api/v1/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "requests": [ { "action_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "occurred_at": "2026-04-15T12:00:00Z", "type": "subscription", "action": "subscribe", "data": { "sync_id": "4648b4d7-90bf-497c-a5e7-8383d1083d76", "guid": "677ea490-690e-51cb-8b43-755df6c55270", "feed_url": "https://example.com/feed1", "subscribed_at": "2026-07-11T15:30:00.1Z" } } ] }'

Post up to 30 actions per batch

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Client-ID
string format: uuid

A unique identifier generated by the client for excluding results

Request Body

Section titled “Request Body”

The array of actions sent to the client

Media typeapplication/json
object
requests
required
Array
One of: discriminator: type
object
action_id
required

The client-generated UUIDv4 identifier for the action

string format: uuid
occurred_at
required

The UTC timestamp at which the action occurred on the client

string format: date-time
type
required
string
action
required
string
data
required
object
type
required
string
Allowed values: subscription
action
required
string
Allowed values: subscribe unsubscribe update
data
required
object
sync_id

The server-generated synchronization ID for the subscription

string format: uuid
guid
required

The guid field as found in the podcast’s RSS feed

string
feed_url
required

The canonical address of the podcast RSS feed

string format: url
subscribed_at
required

The UTC timestamp at which the user subscribed to the feed

string format: date-time
unsubscribed_at

The UTC timestamp at which the user unsubscribed from the feed

string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Actions handled

Media typeapplication/json
object
results
required
Array
One of: discriminator: type
object
action_id
required

The client-generated UUIDv4 identifier for the action

string format: uuid
type
required

The target entity type

string
action
required

The action being taken on the target

string
status
required
string
Allowed values: applied ignored rejected
type
required
string
Allowed values: subscription
action
required
string
Allowed values: subscribe unsubscribe update
data
object
sync_id
required

The server-generated synchronization ID for the subscription

string format: uuid
guid
required

The guid field as found in the podcast’s RSS feed

string
feed_url
required

The canonical address of the podcast RSS feed

string format: url
subscribed_at
required

The UTC timestamp at which the user subscribed to the feed

string format: date-time
unsubscribed_at

The UTC timestamp at which the user unsubscribed from the feed

string format: date-time
Example
{
  "results": [
    {
      "status": "applied",
      "type": "subscription",
      "action": "subscribe",
      "data": {
        "sync_id": "4648b4d7-90bf-497c-a5e7-8383d1083d76",
        "guid": "677ea490-690e-51cb-8b43-755df6c55270",
        "feed_url": "https://example.com/feed1",
        "subscribed_at": "2026-07-11T15:30:00.1Z"
      }
    }
  ]
}

400

Section titled “400”

Bad request

Media typeapplication/json

Generic error object

object
error
required

The error message

string
description
required

The error description

string
Example
{
  "error": "Bad request",
  "description": "The request payload is invalid. Check the number of entries."
}

401

Section titled “401”

Access token is invalid

Media typeapplication/json

Generic error object

object
error
required

The error message

string
description
required

The error description

string
Example
{
  "error": "Unauthorized",
  "description": "The supplied access token is invalid"
}

500

Section titled “500”

Internal server error

Media typeapplication/json

Generic error object

object
error
required

The error message

string
description
required

The error description

string
Example
{
  "error": "Internal server error",
  "description": "The server encountered an error while processing the request"
}