Skip to main content
POST
/
api
/
v1
/
nodes
curl -X POST https://nearnode.io/api/v1/nodes \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Lobby Entrance",
    "function_type": "redirect",
    "payload": {
      "url": "https://acme.com/checkin"
    }
  }'
{
  "data": {
    "id": "node_123abc-def4-5678-ghij-klmnopqrstuv",
    "slug": "o1ulpplq",
    "url": "https://nearnode.io/v/o1ulpplq",
    "function_type": "redirect",
    "status": "active"
  }
}

Body

label
string
required
The internal name for this node (e.g., “Conference Room A”).
function_type
string
required
The payload type. One of redirect, vcard, wifi, microsite, digital_card, or action.
payload
object
required
Type-specific configuration object. See Node Types for payload schemas per type.Redirect: { "url": "https://..." }vCard: { "first_name": "...", "last_name": "...", "email": "...", "phone": "..." }WiFi: { "ssid": "...", "password": "...", "security": "WPA2" }Action: { "action_type": "whatsapp", "phone": "...", "message": "..." }
template_id
string
Bind to a template for enforced brand consistency. Locked fields cannot be overridden.

Response

data
object
curl -X POST https://nearnode.io/api/v1/nodes \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Lobby Entrance",
    "function_type": "redirect",
    "payload": {
      "url": "https://acme.com/checkin"
    }
  }'
{
  "data": {
    "id": "node_123abc-def4-5678-ghij-klmnopqrstuv",
    "slug": "o1ulpplq",
    "url": "https://nearnode.io/v/o1ulpplq",
    "function_type": "redirect",
    "status": "active"
  }
}