Skip to main content
POST
/
admin
/
invites
JS SDK
import Switchyard from "@switchyard/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.invite.create({
  email: "user@gmail.com",
})
.then(({ invite }) => {
  console.log(invite)
})
{
  "invite": {
    "id": "<string>",
    "email": "jsmith@example.com",
    "accepted": true,
    "token": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body

application/json

The invite's details.

​
email
string<email>
required

The email of the user to invite.

​
metadata
object

The invite's metadata. Can be custom data in key-value pairs.

Response

OK

The invite's details.

​
invite
object
required

The invite's details.