Перейти к содержимому
/
Create an invite

Create an invite

Запрос

Requires members.invite. The invite is valid for 7 days; share its url with the new member. The invite may carry any permissions, so grant members.invite only to trusted members. Not available with a legacy company-wide key.

Безопасность
apiKeyAuth
Телоapplication/jsonобязательный
emailstring, (email)

If set, only this email can accept the invite.

rolestringобязательный
Enum:"admin""member"
permissionsArray of stringsобязательный

Values from the Permission catalog; they are not validated against it, and * grants full access.

curl -i -X POST \
  https://b2b-app.lumowallet.io/_mock/apis/members/invites \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "[email protected]",
    "role": "admin",
    "permissions": [
      "string"
    ]
  }'

Ответы

Invite created

Телоapplication/json
idstring, (uuid)
tokenstring
emailstring or null, (email)
rolestring
Enum:"admin""member"
permissionsArray of strings
expiresAtstring, (date-time)

7 days after creation

createdAtstring, (date-time)
urlstring

Link to the cabinet page where the invite is accepted

Ответ
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "token": "string",
  "email": "[email protected]",
  "role": "admin",
  "permissions": [
    "string"
  ],
  "expiresAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "url": "string"
}