Replace the routing of one or more streams

PUT

/api/v1/workspaces/{workspace}/routing

package main

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

func main() {

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

  payload := strings.NewReader("{ \"acknowledgeBulkTerms\": true, \"streams\": [ { \"conditions\": [ { \"field\": \"mailbox_provider\", \"note\": \"example\", \"providerId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"values\": [ \"example\" ] } ], \"failover\": \"automatic\", \"fallback\": \"example\", \"priority\": true, \"splits\": [ { \"providerId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"weight\": 1 } ], \"stream\": \"broadcast\" } ] }")

  req, _ := http.NewRequest("PUT", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  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/routing';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"acknowledgeBulkTerms":true,"streams":[{"conditions":[{"field":"mailbox_provider","note":"example","providerId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","values":["example"]}],"failover":"automatic","fallback":"example","priority":true,"splits":[{"providerId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","weight":1}],"stream":"broadcast"}]}'
};

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

curl --request PUT \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/routing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "acknowledgeBulkTerms": true, "streams": [ { "conditions": [ { "field": "mailbox_provider", "note": "example", "providerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "values": [ "example" ] } ], "failover": "automatic", "fallback": "example", "priority": true, "splits": [ { "providerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "weight": 1 } ], "stream": "broadcast" } ] }'

Permission: providers:manage (sensitive)

Validates splits, fallbacks and conditions against the connected providers. A Broadcast route that a provider’s terms don’t allow is refused with code bulk_terms unless acknowledgeBulkTerms is set; the decision is audited.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

Request Body^required

application/json

object

acknowledgeBulkTerms

boolean

streams

required

Array<object>

>= 1 items <= 4 items

object

conditions

required

Array<object>

<= 20 items

object

field

required

Category: a transactional category (Transactional stream only)

string

Allowed values: mailbox_provider list sender_domain category

note

string

<= 120 characters

providerId

required

string format: uuid

values

required

Array<string>

>= 1 items <= 50 items

failover

required

string

Allowed values: automatic pause_and_ask warm_only

fallback

Provider id, or empty for none

string

priority

boolean

splits

required

Array<object>

<= 5 items

object

providerId

required

string format: uuid

weight

required

integer format: int64

<= 100

stream

required

string

Allowed values: broadcast automation system transactional

Responses

200

application/json

object

categories

required

Array<object>

object

required

string

name

required

string

issues

required

Array<object>

object

blocking

required

boolean

code

required

string

field

string

message

required

string

providerId

string

stream

required

string

lists

required

Array<object>

object

required

string

name

required

string

providers

required

Array<object>

object

adapter

required

string

broadcastStreamCreatable

required

boolean

bulk

required

string

Allowed values: allowed broadcast_streams_only forbidden your_policy

bulkAllowed

required

boolean

color

required

string

Allowed values: ses postal postmark other

required

string

label

required

string

name

required

string

removesWebhook

required

boolean

shareSteps

required

Array<object>

object

day

required

integer format: int64

share

required

integer format: int64

short

required

string

status

required

string

terms

required

Array<object>

object

active

required

boolean

available

required

boolean

bulk

required

string

Allowed values: allowed broadcast_streams_only forbidden your_policy

note

required

string

streams

required

Array<string>

variant

required

string

warmingUp

required

boolean

warmupDay

integer format: int64

warmupDays

integer format: int64

savedAt

string format: date-time

savedBy

required

string

senderDomains

required

Array<string>

shared

required

object

suppressions

required

integer format: int64

syncedAt

string format: date-time

streams

required

Array<object>

object

bulkTermsAcknowledgedAt

string format: date-time

conditions

required

Array<object>

object

field

required

Category: a transactional category (Transactional stream only)

string

Allowed values: mailbox_provider list sender_domain category

note

string

<= 120 characters

providerId

required

string format: uuid

valueLabels

required

Array<string>

values

required

Array<string>

>= 1 items <= 50 items

failover

required

string

Allowed values: automatic pause_and_ask warm_only

fallback

required

string

priority

boolean

senderDomains

Array<string>

splits

required

Array<object>

object

providerId

required

string format: uuid

weight

required

integer format: int64

<= 100

stream

required

string

Allowed values: broadcast automation system transactional

volume

object

count

required

integer format: int64

largest

integer format: int64

per

required

string

Allowed values: day week

smallest

integer format: int64

templates

required

Array<object>

object

required

string

name

required

string

Example

{
  "providers": [
    {
      "bulk": "allowed",
      "color": "ses",
      "terms": [
        {
          "bulk": "allowed"
        }
      ]
    }
  ],
  "streams": [
    {
      "conditions": [
        {
          "field": "mailbox_provider"
        }
      ],
      "failover": "automatic",
      "stream": "broadcast",
      "volume": {
        "per": "day"
      }
    }
  ]
}

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

Replace the routing of one or more streams

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Example

default

Example

Request Body^required