Create Member Session

Create a member session.

This endpoint is only available for organizations with member_model_enabled and seat_based_pricing_enabled feature flags enabled.

Scopes: member_sessions:write

POST /v1/member-sessions

Create Member Session

cURL

curl --request POST \
  --url https://api.spairehq.com/v1/member-sessions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "member_id": "<string>",
  "return_url": "https://example.com/account"
}
'

201

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "token": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "return_url": "<string>",
  "member_portal_url": "<string>",
  "member_id": "<string>",
  "member": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "customer_id": "<string>",
    "email": "<string>",
    "name": "Jane Doe",
    "external_id": "usr_1337"
  },
  "customer_id": "<string>",
  "customer": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "external_id": "usr_1337",
    "email": "<string>",
    "email_verified": true,
    "name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "<string>",
    "type": "individual"
  }
}

Authorizations

patoat

Authorization · string · header · required

You can generate a Personal Access Token from your settings.

Body

application/json

Schema for creating a member session using a member ID.

member_id · string<uuid4> · required

ID of the member to create a session for.

return_url · string<uri> | null

When set, a back button will be shown in the customer portal to return to this URL.

Required string length: 1 - 2083

Example:

"https://example.com/account"

Response

201

application/json

Member session created.

A member session that can be used to authenticate as a member in the customer portal.

created_at · string<date-time> · required

Creation timestamp of the object.

modified_at · string<date-time> | null · required

Last modification timestamp of the object.

id · string<uuid4> · required

The ID of the object.

token · string · required

expires_at · string<date-time> · required

return_url · string | null · required

member_portal_url · string · required

member_id · string<uuid4> · required

member · Member · object · required

A member of a customer.

Show child attributes

customer_id · string<uuid4> · required

customer · Customer · object · required

A customer in an organization.

Show child attributes