Skip to main content
POST
Go (SDK)

Authorizations

Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Body

application/json

Schema for creating a customer session using a customer ID.

customer_id
string<uuid4>
required

ID of the customer to create a session for.

member_id
string<uuid4> | null

ID of the member to create a session for. When not provided and the organization has member_model_enabled, the owner member of the customer will be used for individual customers.

external_member_id
string | null

External ID of the member to create a session for. Alternative to member_id.

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

Customer session created.

A customer session that can be used to authenticate as a customer.

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
customer_portal_url
string
required
customer_id
string<uuid4>
required
customer
CustomerIndividual · object
required

A customer in an organization.