Update whitelisting (legacy)

Edit an existing whitelist entry's name, description, expiry, or tags.

Legacy API

This page describes the legacy Sign In API. New integrations use the Sign In API with an Organization API key. The same operation there: Update a whitelisting.

PUT /v1/org/{organizationId}/contexts/sign-in/{contextId}/modules/whitelistings

Updates an existing whitelist entry. Identify the entry by its id.

Request

Parameter	In	Type	Required	Description
`organizationId`	Path	`string`	Yes	Organization ID.
`contextId`	Path	`string`	Yes	Sign-In Context ID.
`x-auth-token`	Header	`string`	Yes	Context API key.
`id`	Body	`string`	Yes	UUID of the whitelist entry to update.
`mac`	Body	`string`	Yes	Device MAC address, format `AA:BB:CC:DD:EE:FF` or `AA-BB-CC-DD-EE-FF`.
`name`	Body	`string`	Yes	Device name, 2–100 characters.
`description`	Body	`string`		Description, 0–200 characters.
`toDate`	Body	`string (date)`		Expiry date, `YYYY-MM-DD`. Pass `null` to make the entry permanent.
`tags`	Body	`object[]`		Tag array; replaces the current tag set.

Request example

curl -X PUT "$API_HOST/v1/org/$ORG_ID/contexts/sign-in/$CTX_ID/modules/whitelistings" \
  -H "x-auth-token: $NETGRAPH_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "7f2a-...",
    "mac": "AA:BB:CC:DD:EE:FF",
    "name": "Reception printer",
    "description": "Lobby floor — moved to right side",
    "toDate": "2027-06-30",
    "tags": [{ "value": "printer" }, { "value": "lobby" }]
  }'

Response

Response example

HTTP/1.1 200 OK