Skip to main content
POST
/
vendor
/
invites
Create a Member Invite
curl --request POST \
  --url https://api.example.com/vendor/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role": "owner"
}
'
{
  "invite": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "email": "[email protected]",
    "role": "owner",
    "token": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "accepted": true,
    "seller": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "photo": "<string>",
      "address_line": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country_code": "<string>",
      "tax_id": "<string>",
      "members": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "role": "owner",
          "email": "[email protected]",
          "name": "<string>",
          "bio": "<string>",
          "photo": "<string>",
          "seller": "<unknown>"
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
email
string<email>
required

The email address of the member to invite.

​
role
enum<string>
required

The role to assign to the invited member.

Available options:
owner,
admin,
member

Response

201 - application/json

Created

​
invite
Member Invite · object

A member invite object with its properties