Skip to main content
PATCH
/
v1
/
organizations
/
nxosnet
cURL
curl --request PATCH \
  --url https://api.nxos.io/v1/organizations/nxosnet \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "handle": "<string>",
  "showOrganizationName": true
}
'
{
  "object": "nxosnet_settings",
  "enabled": true,
  "handle": "acme",
  "showOrganizationName": true
}

Headers

​
Authorization
string
required

Bearer token. Format: Bearer <api_key>

​
Idempotency-Key
string

Unique key per logical operation. UUID v4 recommended. Max 255 characters.

Body

application/json

Request body for PATCH /v1/organizations/nxosnet. Every field is optional; omitted fields are left unchanged. Supplying no fields is a 400.

​
enabled
boolean

Enable or disable receiving nxosnet transfers. Enabling requires a handle to already be set, or supplied in the same request.

​
handle
string

Claim or change the organization's nxosnet handle. 3-32 chars: lowercase letters, digits, and non-leading/trailing/consecutive hyphens.

​
showOrganizationName
boolean

Show or hide the organization's name to senders resolving its handle.

Response

The request has succeeded.

nxosnet settings for an organization.

​
object
enum<string>
required

Always nxosnet_settings.

Available options:
nxosnet_settings
​
enabled
boolean
required

Whether this organization can receive nxosnet transfers. Requires a handle to be set.

​
handle
string | null
required

The organization's globally-unique nxosnet handle, or null if none has been claimed yet.

​
showOrganizationName
boolean
required

Whether the organization's name is shown to senders who look up its handle.