Sign out of the customer portal

Ends the signed-in customer's portal session at once; the portal also clears its cookie. Other sessions of the customer (other browsers) keep working until they expire.

Customer portal only: the caller is the customer signed in to the brand's portal (portal:write).

At a glance

REST: DELETE /api/v1/portal/me/session
MCP tool: portal_sessions_revoke
Operation ID: portal.sessions.revoke
Scope: Brand
Permission: portal:write
Risk tier: write
Dry run: Not supported
Idempotency: Idempotency-Key optional
Modes: Test and live
Authentication: A customer signed in to the customer portal (API keys can't call it)
Since: M9

Request

Body

This operation takes no body.

Response

200 OK with a JSON object:

Field	Type	Description
`object`	`"portal_session"`
`id`	`psess_…` ID
`signedOut`	`true`

Examples

Sign out

HTTP

DELETE /api/v1/portal/me/session
Authorization: Bearer or_test_…

Response (200):

JSON

{
  "object": "portal_session",
  "id": "psess_01m4tx5nj8emwbyf7y9vcf48b2",
  "signedOut": true
}

Errors

Code	HTTP status	When	What to do
`livemode_not_allowed`	403	The portal session is in the other mode than the request.	Use test mode, or credentials for the target's mode. Developers need live access granted by an organization owner or admin.
`permission_denied`	403	The caller isn't a customer signed in to this brand's portal (operators and API keys use the customer operations).	Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: validation_failed, api_version_unsupported, invalid_json, unsupported_media_type, authentication_required, api_key_invalid, scope_required, resource_not_found, idempotency_key_reused, idempotency_in_progress, dry_run_not_supported, rate_limited, internal_error.

At a glance#

Request#

Body#

Response#

Examples#

Sign out#

Errors#