Skip to content

Save the default From, reply handling, footer address and link tracking domain

PUT
/api/v1/workspaces/{workspace}/senders/defaults
curl --request PUT \
--url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/senders/defaults \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "defaultSenderId": "example", "footerAddress": "example", "replyHandling": "forward", "replyTo": "example", "trackingDomain": "example", "transactionalSenderId": "example" }'

Permission: domains:manage (sensitive)

workspace
required

Workspace slug

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

Workspace slug

Media typeapplication/json
object
defaultSenderId

Default From for new campaigns (the Broadcasts default)

string
footerAddress
required
string
<= 300 characters
replyHandling
required
string
Allowed values: forward
replyTo
string
<= 254 characters
trackingDomain

Empty for the provider default

string
<= 253 characters
transactionalSenderId
string
<= 36 characters

OK

Media typeapplication/json
object
automationSenderId
required
string
defaultSenderId
required
string
footerAddress
required
string
replyHandling
required
string
Allowed values: forward
replyOptions
required
Array<string>
replyTo
required
string
systemSenderId
required
string
trackingDomain
required
string
trackingOptions
required
Array<object>
object
domain
required
string
verified
required
boolean
transactionalSenderId
required
string

Example

{
"replyHandling": "forward"
}

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