GOV.UK Notify · Example Payload

Send Sms

Example request and response for sending an SMS text message via the GOV.UK Notify API.

NotificationEmailSMSText MessagesLettersGovernmentUnited KingdomPublic SectorGDSREST

Send Sms is an example object payload from GOV.UK Notify, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

summarydescriptionrequestresponse

Example Payload

{
  "summary": "Send an SMS notification",
  "description": "Example request and response for sending an SMS text message via the GOV.UK Notify API.",
  "request": {
    "method": "POST",
    "url": "https://api.notifications.service.gov.uk/v2/notifications/sms",
    "headers": {
      "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "Content-Type": "application/json"
    },
    "body": {
      "phone_number": "+447900900123",
      "template_id": "f33517ff-2a88-4f6e-b855-c550268ce08a",
      "personalisation": {
        "name": "Jane",
        "appointment_date": "1 January 2024",
        "appointment_time": "2:00pm"
      },
      "reference": "appointment-reminder-jane-001"
    }
  },
  "response": {
    "status": 201,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "id": "740e5834-3a29-46b4-9a6f-16142fde533a",
      "reference": "appointment-reminder-jane-001",
      "content": {
        "body": "Hi Jane, your appointment is on 1 January 2024 at 2:00pm.",
        "from_number": "GOVUK"
      },
      "uri": "https://api.notifications.service.gov.uk/v2/notifications/740e5834-3a29-46b4-9a6f-16142fde533a",
      "template": {
        "id": "f33517ff-2a88-4f6e-b855-c550268ce08a",
        "version": 1,
        "uri": "https://api.notifications.service.gov.uk/v2/template/f33517ff-2a88-4f6e-b855-c550268ce08a/version/1"
      }
    }
  }
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this

find_examplesBrowse and filter every example in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This example

curl "https://apis.io/api/v1/examples/send-sms"

All examples

curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.