Templates

Template IDs are slugs you choose, such as order_shipped. A template takes the same fields as a send, and {{name}} placeholders in any field are filled from vars. Templates explains why they keep requests small.

Create or replace

PUT /v1/templates/{id}

Needs templates: write. Saving an existing ID replaces it.

TypeScriptPythonGoRustRubycURL

TypeScript

await fleet.templates.put("order_shipped", {
  title: "Your order shipped",
  body: "Arriving {{eta}}",
});

Python

fleet.templates.put(
    "order_shipped",
    title="Your order shipped",
    body="Arriving {{eta}}",
)

Go

fleet.Templates.Put(ctx, "order_shipped", pushfleet.TemplatesPutParams{
	Title: "Your order shipped",
	Body:  "Arriving {{eta}}",
})

Rust

fleet
    .templates()
    .put("order_shipped")
    .title("Your order shipped")
    .body("Arriving {{eta}}")
    .await?;

Ruby

fleet.templates.put(
  "order_shipped",
  title: "Your order shipped",
  body: "Arriving {{eta}}"
)

cURL

curl -X PUT https://api.pushfleet.com/v1/templates/order_shipped \
  -H "Authorization: Bearer $PUSHFLEET_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Your order shipped","body":"Arriving {{eta}}"}'

Read

GET /v1/templates/{id}

TypeScriptPythonGoRustRubycURL

TypeScript

await fleet.templates.get("order_shipped");

Python

fleet.templates.get("order_shipped")

Go

fleet.Templates.Get(ctx, "order_shipped")

Rust

fleet.templates().get("order_shipped").await?;

Ruby

fleet.templates.get("order_shipped")

cURL

curl https://api.pushfleet.com/v1/templates/order_shipped \
  -H "Authorization: Bearer $PUSHFLEET_SECRET_KEY"

Delete

DELETE /v1/templates/{id}

Sends that still name the template get 404 not_found.

TypeScriptPythonGoRustRubycURL

TypeScript

await fleet.templates.delete("order_shipped");

Python

fleet.templates.delete("order_shipped")

Go

fleet.Templates.Delete(ctx, "order_shipped")

Rust

fleet.templates().delete("order_shipped").await?;

Ruby

fleet.templates.delete("order_shipped")

cURL

curl -X DELETE https://api.pushfleet.com/v1/templates/order_shipped \
  -H "Authorization: Bearer $PUSHFLEET_SECRET_KEY"