Rivier/ Reference/ workspace

End a connection

post/connected-businesses/{id}/end

End a connection: the platform's calls into that business stop at once. The business and everything in it stay with its owner.

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:admin
Graphql
Mutation.workspaceConnectedBusinessEnd
Sdk
workspace.connectedBusiness.end
Cli
workspace connected business end

Parameters

  • idstring (uuid)required
    In the path

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown