Skip to main content
POST
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Path Parameters

seller_id
string
required

Seller prefixed ID

Body

application/json
email
string
required
Example:

"teammate@example.com"

Response

invitation sent

id
string
required
email
string
required
status
required

The values listed are the built-in ones; extensions may add more.

Available options:
pending,
accepted
created_at
string
required
updated_at
string
required
expires_at
string
required
role_id
string
required
role_name
string
required
inviter_email
string
required
invitee_exists
boolean
required
store
object
required