Create a trial activation

Creates a new trial activation.

POST/v3/trial-activations

Request Body Schema

PropertyTypeDescriptionConstraints
os*stringName of the operating system.enum: [windows, linux, macos, android, ios]
osVersionstringVersion of the operating system.min: 0, max: 256
fingerprint*stringFingerprint of the machine.min: 64, max: 1024
vmNamestringName of the virtual machine.min: 0, max: 256
containerbooleanWhether app is run inside a container.
hostname*stringName of the host machine.min: 1, max: 1024
userHash*stringHash of the machine user name.min: 1, max: 256
productId*stringUnique identifier for the product.min: 1, max: 256
accountId*stringUnique identifier for the account.min: 0, max: 256
releaseVersionstringThe release version of the app. Only following three formats are allowed x.x, x.x.x, x.x.x.x.min: 0, max: 256
releaseChannelstringThe release channel of the app.min: 0, max: 256
releasePlatformstringThe release platform of the app.min: 0, max: 256
releasePublishedAtstringThis release published date (UTC) of the app.format: date-time
metadataarrayList of metdata key/value pairs.items: object
key*stringName of the key.min: 1, max: 256
value*stringValue of the key.min: 0, max: 4096

Request Example

{
  "os": "windows",
  "osVersion": "string",
  "fingerprint": "stringstringstringstringstringstringstringstringstringstringstri",
  "vmName": "string",
  "container": true,
  "hostname": "string",
  "userHash": "string",
  "productId": "string",
  "accountId": "string",
  "releaseVersion": "string",
  "releaseChannel": "string",
  "releasePlatform": "string",
  "releasePublishedAt": "2019-08-24T14:15:22Z",
  "metadata": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Triggers webhook: trialActivation.created
POST <your-webhook-url>
{
  "event": "trialActivation.created",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "os": "windows",
    "osVersion": "string",
    "hostname": "string",
    "location": {
      "ipAddress": "string",
      "countryCode": "string",
      "countryName": "string",
      "regionCode": "string",
      "regionName": "string",
      "city": "string",
      "zipCode": "string",
      "timeZone": "string",
      "latitude": 0.1,
      "longitude": 0.1
    },
    "vmName": "string",
    "container": true,
    "appVersion": "string",
    "releaseVersion": "string",
    "releaseChannel": "string",
    "releasePlatform": "string",
    "offline": true,
    "productId": "string",
    "expiresAt": "2019-08-24T14:15:22Z",
    "metadata": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "key": "string",
        "value": "string"
      }
    ]
  },
  "triggeredAt": "string"
}

Responses

201 Created
{
  "trialActivationToken": "string"
}