Skip to main content
POST
/
v2
/
access
/
promotions
/
trial-links
Create trial link
curl --request POST \
  --url https://api.ofauth.com/v2/access/promotions/trial-links \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '
{
  "trialLinkName": "<string>",
  "subscribeDays": 183,
  "subscribeCounts": 2,
  "expiredAt": "<string>"
}
'
{
  "id": 123,
  "trialLinkName": "<string>",
  "url": "<string>",
  "subscribeDays": 123,
  "subscribeCounts": 123,
  "claimCounts": 123,
  "clicksCounts": 123,
  "expiredAt": "<string>",
  "createdAt": "<string>",
  "isFinished": true,
  "user": null,
  "sharedWith": "<string>"
}

Authorizations

​
apiKey
string
header
required

Your OFAuth API key for authenticating requests.

​
x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Body

application/json
​
trialLinkName
string
required

Name for the trial link

Required string length: 1 - 100
​
subscribeDays
integer
required

Number of days for trial subscription

Required range: 1 <= x <= 365
​
subscribeCounts
integer

Maximum number of times trial can be claimed

Required range: x >= 1
​
expiredAt
string

When the trial link expires

Response

Successful response

​
id
number
required
​
trialLinkName
string
required
​
url
string
required
​
subscribeDays
number
required
​
subscribeCounts
number
required
​
claimCounts
number
required
​
clicksCounts
number
required
​
expiredAt
string | null
required
​
createdAt
string
required
​
isFinished
boolean
required
​
user
unknown
​
sharedWith
string | null