OrgsMarvis Invites

updateOrgMarvisClientInvite

PUT
/api/v1/orgs/{org_id}/marvisinvites/{marvisinvite_id}

Update a Marvis Client onboarding invite profile, including enabled telemetry, location, and synthetic-test capabilities.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid
marvisinvite_id*string
Formatuuid

Request Body

application/json

Marvis Client configuration profile

disabled?boolean

Whether this Marvis Client profile is disabled

Defaultfalse
location?

Client location collection settings for Marvis Client

name?string

Display name for the Marvis Client profile

synthetic_test?

Synthetic test settings for Marvis Client

telemetry?

Client telemetry collection settings for Marvis Client

Response Body

curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/marvisinvites/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "location": {      "enabled": true    },    "name": "Handhelds",    "synthetic_test": {      "enabled": true    },    "telemetry": {      "enabled": true    }  }'
{  "enrollment_url": "marvisclient://api.mist.com/path/to/url",  "id": "3a14098f-b995-7552-b0a4-b8ee39b337a6",  "name": "Handhelds"}