Pass Delivery

Index

• POST /api/v1/pass/{id}/distribute/sms - Send SMS for pass

Send SMS for pass

Sends an SMS for an existing pass.

The SMS can be customized with your own content and sender name.

See Template Tokens on SmartPages for a list of available tokens that you can use in the custom SMS content.

The Phone number must be in E.164 format, e.g. +3541234567 .

Note

The Issuer account will be charged for the SMS delivery cost. The cost depends on the message length and the number of message parts.

Request

POST https://smartpages-api.smartsolutions.is/api/v1/pass/{id}/distribute/sms { "phoneNumber": "+3541234567", "content": { "sendCustomSms": true, "customContent": "Here is your pass! Click the link to add it to your wallet: ${url}", "customSender": "MyCompany" } }

Request fields

phoneNumber string Optional

The phone number to which the pass should be sent. Should be in E.164 format. If not provided, the SMS will be sent to the number registered on the Pass. Will update the phone number stored on the Pass.

content object Optional

Custom SMS content, if not included we'll use the SMS Template as designed for the Pass Template, fails if both are missing.

sendCustomSms boolean Optional

Wether to use the Custom SMS content

customSender string Optional

The sender of the SMS message, e.g. your brand name. Will show up as the sender on the customer's device. Approval of the sender name beforehand is required.

customContent string Optional

The content of the SMS message that will be sent to the customer. Can include a placeholder {url} that will be replaced with the actual pass download link. Full list of template tokens can be found on SmartPages

Response

Example

{ "id": "19700910-7195-4d57-b402-886ff7439e44", "phoneNumber": "+3541234567", "messageParts": 1, "messageLength": 75, "whenQueued": "2025-07-15T12:00:00.000Z" }

Fields details

id UUID

ID of the SMS

phoneNumber string Optional

The Phone Number the SMS was sent to.

messageParts integer

How many parts the message was split into, as per carrier requirements.

messageLength integer

How long the message is in characters.

whenQueued timestampz

When the SMS message was queued for delivery.

Code example

Node.js (fetch)

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer <base64(KEY_ID:KEY_TOKEN)>");

const raw = JSON.stringify({
    "phoneNumber": "+3541234567",
    "content": {
        "sendCustomSms": true,
        "customContent": "Here is your pass! Click the link to add it to your wallet: ${url}",
        "customSender": "MyCompany"
    }
});

const requestOptions = {
    method: "POST",
    headers: myHeaders,
    body: raw,
    redirect: "follow"
};

try {
    const response = await fetch("https://smartpages-api.smartsolutions.is/api/v1/pass/{id}/distribute/sms", requestOptions);
    const result = await response.text();
    console.log(result)
} catch (error) {
    console.error(error);
};

Node.js (axios)

const axios = require('axios');
let data = JSON.stringify({
    "phoneNumber": "+3541234567",
    "content": {
        "sendCustomSms": true,
        "customContent": "Here is your pass! Click the link to add it to your wallet: ${url}",
        "customSender": "MyCompany"
    }
});

let config = {
    method: 'post',
    maxBodyLength: Infinity,
    url: 'https://smartpages-api.smartsolutions.is/api/v1/pass/{id}/distribute/sms',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer <base64(KEY_ID:KEY_TOKEN)>'
    },
    data : data
};

async function makeRequest() {
    try {
        const response = await axios.request(config);
        console.log(JSON.stringify(response.data));
    }
    catch (error) {
        console.log(error);
    }
}

makeRequest();

Python

import requests
import json

url = "https://smartpages-api.smartsolutions.is/api/v1/pass/{id}/distribute/sms"

payload = json.dumps({
    "phoneNumber": "+3541234567",
    "content": {
        "sendCustomSms": True,
        "customContent": "Here is your pass! Click the link to add it to your wallet: ${url}",
        "customSender": "MyCompany"
    }
})
headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <base64(KEY_ID:KEY_TOKEN)>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Kotlin

val client = OkHttpClient()
val mediaType = "application/json".toMediaType()
val body = "{\"phoneNumber\":\"+3541234567\",\"content\":{\"sendCustomSms\":true,\"customContent\":\"Here is your pass! Click the link to add it to your wallet: ${url}\",\"customSender\":\"MyCompany\"}}".toRequestBody(mediaType)
val request = Request.Builder()
    .url("https://smartpages-api.smartsolutions.is/api/v1/pass/{id}/distribute/sms")
    .post(body)
    .addHeader("Content-Type", "application/json")
    .addHeader("Authorization", "Bearer <base64(KEY_ID:KEY_TOKEN)>")
    .build()
val response = client.newCall(request).execute()

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://smartpages-api.smartsolutions.is/api/v1/pass/{id}/distribute/sms");
request.Headers.Add("Authorization", "Bearer <base64(KEY_ID:KEY_TOKEN)>");
var content = new StringContent("{\"phoneNumber\":\"+3541234567\",\"content\":{\"sendCustomSms\":true,\"customContent\":\"Here is your pass! Click the link to add it to your wallet: ${url}\",\"customSender\":\"MyCompany\"}}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Rust

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = reqwest::Client::builder()
        .build()?;

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Content-Type", "application/json".parse()?);
    headers.insert("Authorization", "Bearer <base64(KEY_ID:KEY_TOKEN)>".parse()?);

    let data = r#"{
    "phoneNumber": "+3541234567",
    "content": {
        "sendCustomSms": true,
        "customContent": "Here is your pass! Click the link to add it to your wallet: ${url}",
        "customSender": "MyCompany"
    }
}"#;

    let json: serde_json::Value = serde_json::from_str(&data)?;

    let request = client.request(reqwest::Method::POST, "https://smartpages-api.smartsolutions.is/api/v1/pass/{id}/distribute/sms")
        .headers(headers)
        .json(&json);

    let response = request.send().await?;
    let body = response.text().await?;

    println!("{}", body);

    Ok(())
}