Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API key authentication. Pass Authorization: Bearer ek_live_xxxxx on every request.

Path Parameters

ws
required
Required string length: 2 - 48
Pattern: ^[a-z0-9-]+$

Body

application/json
email
string<email>
required
Required string length: 1 - 255
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
role
enum<string>
required
Available options:
admin,
developer,
member
scope
object
required

Response

200 - application/json

Default Response

success
boolean
required