MspsLicenses

moveOrDeleteMspLicenseToAnotherOrg

PUT
/api/v1/msps/{msp_id}/licenses

Perform an MSP license action, such as amending license quantity to an organization, deleting a subscription, undoing an amendment, or annotating a subscription.

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

msp_id*string
Formatuuid

Request Body

application/json

License operation request for an MSP account

amendment_id?string

Required if op==unamend; identifies the license amendment to undo

dst_org_id?string

Required if op==amend; destination org ID that receives the amended license quantity

Formatuuid
notes?string

Required if op==annotate; note text to attach to the license action

op*msp_license_action_operation

License operation to perform for this MSP request. enum: amend, annotate, delete, unamend.

Length1 <= length

Value in

  • "amend"
  • "annotate"
  • "delete"
  • "unamend"
quantity?number

Required if op==amend; license quantity to move to the destination org

subscription_id?string

Required if op==annotate; subscription ID for the license action

Length1 <= length

Response Body

curl -X PUT "https://example.com/api/v1/msps/000000ab-00ab-00ab-00ab-0000000000ab/licenses" \  -H "Content-Type: application/json" \  -d '{    "op": "delete",    "subscription_id": "SUB-0000144"  }'
Empty