Skip to content

updateSourceSettings

PATCH
/settings/sources
curl --request PATCH \
  --url http://localhost:8080/api/v1/settings/sources \
  --header 'Content-Type: application/json' \
  --cookie hs_session=<hs_session> \
  --data '{ "xApiKey": "example", "xMonthlyBudgetUsd": 1, "intervals": { "serverS": 1, "agentS": 1 }, "retentionDays": { "story": 1, "post": 1 }, "mediaCacheEnabled": true, "agentMaxFetchesPerPlatformPerHour": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
xApiKey

Null removes the key.

string | null
xMonthlyBudgetUsd
number
<= 1000
intervals
object
serverS
integer
>= 900 <= 86400
agentS
integer
>= 1800 <= 86400
retentionDays
object
story
integer
>= 1 <= 365
post
integer
>= 1 <= 3650
mediaCacheEnabled
boolean
agentMaxFetchesPerPlatformPerHour
integer
>= 1 <= 120

Example generated

{
  "xApiKey": "example",
  "xMonthlyBudgetUsd": 1,
  "intervals": {
    "serverS": 1,
    "agentS": 1
  },
  "retentionDays": {
    "story": 1,
    "post": 1
  },
  "mediaCacheEnabled": true,
  "agentMaxFetchesPerPlatformPerHour": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Updated.

Media typeapplication/json
object
xApiKeySet
required
boolean
xMonthlyBudgetUsd
required
number
xSpentUsdThisMonth
required
number
intervals
required
object
serverS
required
integer
agentS
required
integer
retentionDays
required
object
story
required
integer
post
required
integer
mediaCacheEnabled
required
boolean
agentMaxFetchesPerPlatformPerHour
required
integer

Examples

Exampleseed

Derived from fixtures/seed.json.

{
  "agentMaxFetchesPerPlatformPerHour": 30,
  "intervals": {
    "agentS": 43200,
    "serverS": 21600
  },
  "mediaCacheEnabled": true,
  "retentionDays": {
    "post": 3650,
    "story": 7
  },
  "xApiKeySet": false,
  "xMonthlyBudgetUsd": 5,
  "xSpentUsdThisMonth": 0
}

400

Section titled “400”

Invalid request.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
code
required
string
i18nKey
string
detail
string
fields
Array<object>
object
path
required
string
code
required
string
i18nKey
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "i18nKey": "example",
  "detail": "example",
  "fields": [
    {
      "path": "example",
      "code": "example",
      "i18nKey": "example"
    }
  ]
}