Send a test through the new provider

POST

/api/v1/workspaces/{workspace}/connect/setups/{setupId}/test

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/connect/setups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "seeds": { "additionalProperty": "example" }, "senderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "subject": "example", "to": "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

setupId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

seeds

object

key

additional properties

string

senderId

required

string format: uuid

subject

required

string

>= 1 characters <= 200 characters

to

string

<= 254 characters

Example ^generated

{
  "seeds": {
    "additionalProperty": "example"
  },
  "senderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "subject": "example",
  "to": "example"
}

Responses

200

OK

Media typeapplication/json

object

auth

object

clipped

required

boolean

dkim

required

string

Allowed values: pass fail none

dmarc

required

string

Allowed values: pass fail none

header

required

string

receiver

required

string

sizeKb

required

integer format: int64

spf

required

string

Allowed values: pass fail none

listening

required

boolean

messageId

required

string

roundTrip

required

string

seedList

required

object

key

additional properties

string

seeds

required

Array<string>

senderId

required

string

senders

required

Array<object>

object

id

required

string

label

required

string

verified

required

boolean

subject

required

string

timeline

required

Array<object>

object

at

string format: date-time

detail

required

string

key

required

string

Allowed values: queued accepted sent delivered opened

status

required

string

Allowed values: done waiting failed

title

required

string

to

required

string

Example

{
  "auth": {
    "dkim": "pass",
    "dmarc": "pass",
    "spf": "pass"
  },
  "timeline": [
    {
      "key": "queued",
      "status": "done"
    }
  ]
}

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