Skip to content
Whitelisting

Update whitelisting

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

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

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

ParameterInTypeRequiredDescription
organizationIdPathstringYesOrganization ID.
contextIdPathstringYesSign-In Context ID.
x-auth-tokenHeaderstringYesContext API key.
idBodystringYesUUID of the whitelist entry to update.
macBodystringYesDevice MAC address, format AA:BB:CC:DD:EE:FF or AA-BB-CC-DD-EE-FF.
nameBodystringYesDevice name, 2–100 characters.
descriptionBodystringDescription, 0–200 characters.
toDateBodystring (date)Expiry date, YYYY-MM-DD. Pass null to make the entry permanent.
tagsBodyobject[]Tag array; replaces the current tag set.

Request example

cURL
curl -X PUT "$API_BASE_URL/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 example

200
HTTP/1.1 200 OK

Next