Lists, forms, fields, emails, providers, tags and events steps can use

GET

/api/v1/workspaces/{workspace}/automations/options

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/automations/options"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/automations/options';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/automations/options \
  --header 'Authorization: Bearer <token>'

Permission: automations:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

Responses

200

application/json

object

emails

required

Array<object>

object

required

string

latestVersion

required

integer format: int64

name

required

string

subject

required

string

updatedAt

required

string format: date-time

events

required

Array<string>

fields

required

Array<object>

object

key

required

string

label

required

string

type

required

string

forms

required

Array<object>

object

required

string

name

required

string

slug

required

string

lists

required

Array<object>

object

required

string

name

required

string

milestones

required

Array<object>

object

count

required

integer format: int64

required

string

listName

required

The list of the milestone’s referral program

string

name

required

string

programId

required

string

reward

required

string

products

required

Array<object>

object

required

string

name

required

string

providers

required

Array<object>

object

adapter

required

string

detail

string

downReason

string

downSince

string format: date-time

required

string

lastErrorStatus

integer format: int64

name

required

string

short

required

string

status

required

Healthy, degraded, down, sandbox, warming_up or paused

string

weight

integer format: int64

scoreBands

object

hotFrom

required

integer format: int64

>= 2 <= 100

warmFrom

required

integer format: int64

>= 1 <= 99

tags

required

Array<string>

Example

{
  "milestones": [
    {
      "count": 3,
      "listName": "Weekly Digest",
      "name": "3 referrals · The Acme Field Guide",
      "reward": "The Acme Field Guide"
    }
  ],
  "providers": [
    {
      "name": "Amazon SES",
      "short": "SES"
    }
  ]
}

default

Error

application/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"
}