Sign in
customer-sessions
public

Create Customer Session

Create a customer session.

For organizations with member_model_enabled, this will automatically create a member session for the owner member of the customer.

Scopes: customer_sessions:write

post/v1/customer-sessions/

Request body

OR

Example request

{
  "return_url": "https://example.com/account"
}

Response

Customer session created.

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

idstring uuid4 required

The ID of the object.

tokenstring required
expires_atstring date-time required
return_urlstring nullable required
customer_portal_urlstring required
customer_idstring uuid4 required
customerCustomer required— unresolved $ref

Changes

Changed in 1 of the 11 revisions of this API.2

  • f9688fd328d62See the full diff
    • ○

      added the required property customer/oneOf[subschema #1: CustomerIndividual]/first_user_event_at to the response with the 201 status

      response-required-property-added

    • ○

      added the required property customer/oneOf[subschema #2: CustomerTeam]/first_user_event_at to the response with the 201 status

      response-required-property-added