Skip to main content
POST
/
v1
/
passes
/
batch
Create passes in batch
curl --request POST \
  --url https://api.passlet.io/v1/passes/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "passes": [
    {
      "externalPassId": "<string>",
      "label": "<string>",
      "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variables": {}
    }
  ]
}
'
import requests

url = "https://api.passlet.io/v1/passes/batch"

payload = { "passes": [
{
"externalPassId": "<string>",
"label": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
passes: [
{
externalPassId: '<string>',
label: '<string>',
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variables: {}
}
]
})
};

fetch('https://api.passlet.io/v1/passes/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.passlet.io/v1/passes/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'passes' => [
[
'externalPassId' => '<string>',
'label' => '<string>',
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variables' => [

]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.passlet.io/v1/passes/batch"

payload := strings.NewReader("{\n \"passes\": [\n {\n \"externalPassId\": \"<string>\",\n \"label\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {}\n }\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.passlet.io/v1/passes/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"passes\": [\n {\n \"externalPassId\": \"<string>\",\n \"label\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {}\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.passlet.io/v1/passes/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"passes\": [\n {\n \"externalPassId\": \"<string>\",\n \"label\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {}\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "totalRequested": 0,
  "totalCreated": 0,
  "totalFailed": 0,
  "results": [
    {
      "externalPassId": "<string>",
      "success": true,
      "pass": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "externalPassId": "<string>",
        "label": "<string>",
        "version": 123,
        "templateVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variables": {},
        "redemption": {
          "windows": [
            {
              "start": "<string>",
              "end": "<string>",
              "maxUses": 50000
            }
          ],
          "maxUses": 50000,
          "perPeriod": {
            "count": 50000,
            "timezone": "<string>"
          },
          "minIntervalMinutes": 263520,
          "activation": {
            "basis": "<string>",
            "validForHours": 43920
          }
        },
        "expiresAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "hostedLinks": {
          "apple": "<string>",
          "google": "<string>"
        }
      },
      "error": {
        "code": "<string>",
        "message": "<string>"
      }
    }
  ]
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}
{
"message": "<string>",
"correlationId": "<string>",
"details": {}
}

Authorizations

Authorization
string
header
required

Passlet access token (plt_*) sent as Authorization: Bearer <token> or X-API-Key. Authorized scopes are listed per operation under x-required-scopes.

Body

application/json
passes
object[]
required

Array of passes to create (max 100)

Required array length: 1 - 100 elements

Response

OK

totalRequested
integer
required

Total passes requested

Required range: -9007199254740991 <= x <= 9007199254740991
totalCreated
integer
required

Total passes successfully created

Required range: -9007199254740991 <= x <= 9007199254740991
totalFailed
integer
required

Total passes that failed

Required range: -9007199254740991 <= x <= 9007199254740991
results
object[]
required

Results for each pass