Ask the owner of a business to connect it to this platform

post/connected-businesses

Ask the owner of a business to connect it to this platform: name it, give their address and the scopes the platform asks for. They are mailed an invitation, accept it in their own organisation and choose what the platform may do. the platform hears platform.business.connected, .declined, .granted and .ended.

Before you call

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

Request bodyapplication/json, required

namestringrequired
At most 120 characters.
emailstring (email)required
At most 254 characters.
scopeslist of stringrequired
refstring
At most 120 characters.
languagestring
At most 12 characters.

Responses

201application/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

Example request

curl -X POST 'https://api.rivier.ai/connected-businesses' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "email": "name@example.com",
  "scopes": [
    "string"
  ]
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown