Skip to content
ReputeCastReputeCast Docs

Send a new download link, to the address on the order only

POST
/api/v1/workspaces/{workspace}/products/orders/{order}/new-link
curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/products/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/new-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "requestedBy": "example" }'

Permission: orders:manage

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

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

Workspace slug

order
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
requestedBy
string
<= 200 characters

Example generated

{
  "requestedBy": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
activity
required
Array<object>
object
allowed
integer format: int32
amount
integer format: int64
at
required
string format: date-time
auto

Done by the system, as the product’s setting says

boolean
by
required
string
byStripe

Done in Stripe’s dashboard

boolean
bytes
integer format: int64
count
integer format: int64
currency
string
email
string
file
string
kind
required
string
Allowed values: checkout_started paid delivery_sent delivery_delivered delivery_failed downloaded refunded dispute_opened dispute_closed access_revoked access_restored new_link buyer_asked
note
string
outcome
string
page
string
provider
string
reason
string
respondBy
string format: date-time
seconds
number format: double
stripe
string
template
string
ticked
boolean
used
integer format: int32
version
integer format: int32
amountCents
required
integer format: int64
buyer
required
object
confirmedAt
string format: date-time
contactId
string
contactSince
string format: date-time
doubleOptIn
required
boolean
email
required
string
kind
required
string
Allowed values: contact joined none
list
required
string
listStatus
required
string
Allowed values: "" pending subscribed unsubscribed
name
required
string
buyerEmail
required
string
canRestore
required
boolean
canRevoke
required
boolean
canSendLink
required
boolean
consent
required
object
at
string format: date-time
ip
required
string
list
required
string
offered
required
boolean
page
required
string
text
required
string
ticked
required
boolean
currency
required
string
delivery
object
deliveredAt
string format: date-time
messageId
string
newLink
required
boolean
provider
required
string
seconds
required
number format: double
sentAt
string format: date-time
status
required
string
template
required
string
version
required
integer format: int32
disputeReason
required
string
disputeStatus
required
string
Allowed values: "" open won lost
disputedAt
string format: date-time
download
required
object
allowed
required
integer format: int32
deliveredAt
string format: date-time
error
string
expiresAt
string format: date-time
newLink
required
boolean
newLinkAt
string format: date-time
newLinkBy
required
string
provider
required
string
revokeReason
required
string
Allowed values: "" manual refund dispute
revokedAt
string format: date-time
revokedBy
required
string
sentAt
string format: date-time
state
required
string
Allowed values: pending sent delivered failed expired used_up revoked revoked_auto
used
required
integer format: int32
downloads
required
object
addresses
required

Distinct IP addresses (kept only as hashes)

integer format: int64
count
required
integer format: int64
first
string format: date-time
last
string format: date-time
files
required
object
bytes
required
integer format: int64
count
required
integer format: int64
kind
required

The first file’s kind in capitals (PDF, ZIP, XLSX)

string
pages
required

The first file’s pages, for a PDF

integer format: int64
helpers
required
Array<string>
id
required
string
number
required
integer format: int64
paidAt
required
string format: date-time
payWhatYouWant
required
boolean
payment
required
object
account
required
string
amountCents
required
integer format: int64
currency
required
string
disputeDueBy
string format: date-time
disputeFeeCents
required
integer format: int64
disputeReason
required
string
disputeStatus
required
string
Allowed values: "" open won lost
disputeUrl
required
string
mode
required
string
Allowed values: live test
provider
required
string
refundedAt
string format: date-time
refundedCents
required
integer format: int64
taxCents
required
integer format: int64
url
required
string
price
required
object
amountCents
required
integer format: int64
<= 100000000
kind
required
string
Allowed values: one_time pwyw
minimumCents
required
integer format: int64
<= 100000000
suggestedCents
required
integer format: int64
<= 100000000
product
required

The product’s short name (Field Guide)

string
productAlt
required
string
productCover
required
string
productId
required
string
productName
required
string
refundedAt
string format: date-time
refundedCents
required
integer format: int64
route
required
string
status
required
string
Allowed values: paid refunded partially_refunded disputed
test
required
boolean

Example 

{
  "activity": [
    {
      "kind": "checkout_started"
    }
  ],
  "buyer": {
    "kind": "contact",
    "listStatus": ""
  },
  "disputeStatus": "",
  "download": {
    "revokeReason": "",
    "state": "pending"
  },
  "payment": {
    "disputeStatus": "",
    "mode": "live"
  },
  "price": {
    "kind": "one_time"
  },
  "status": "paid"
}

default

Section titled “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"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0