Change a site's label, worker and icon (logged)

PUT

/api/v1/workspaces/{workspace}/push/sites/{siteId}

curl --request PUT \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/push/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "iconMediaId": "example", "label": "example", "workerMode": "file", "workerPath": "example" }'

• Your ReputeCast public URL

Permission: providers:manage (sensitive)

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

siteId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

iconMediaId

string

<= 40 characters

label

required

string

<= 80 characters

workerMode

required

string

Allowed values: file import

workerPath

required

string

<= 200 characters

Responses

200

OK

Media typeapplication/json

object

addedAt

required

string format: date-time

addedBy

required

string

demo

required

boolean

host

required

string

iconUrl

string

id

required

string

kind

required

string

Allowed values: publication snippet

label

required

string

linked

required

integer format: int64

origin

required

string

prompts

required

Array<object>

object

formId

required

string

liveSince

string format: date-time

name

required

string

status

required

string

Allowed values: draft live paused

style

required

string

Allowed values: bar dialog bell

snippetSeenAt

string format: date-time

subscribers

required

integer format: int64

worker

required

object

checkedAt

string format: date-time

current

required

integer format: int64

detail

string

httpStatus

integer format: int64

mode

required

string

Allowed values: file import

path

required

string

scope

required

string

status

required

string

Allowed values: built_in found old_version missing unreachable not_a_worker unchecked

url

required

string

version

integer format: int64

Example

{
  "kind": "publication",
  "prompts": [
    {
      "status": "draft",
      "style": "bar"
    }
  ],
  "worker": {
    "mode": "file",
    "status": "built_in"
  }
}

default

Error

Media typeapplication/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}