SUsuperwall
App User Erasures V2

Request App User Erasure

Changed on

Schedules the erasure of one app user from every application in the application's project, since a user's subscriptions and web purchases span them. It runs 25 days later and can be cancelled until then. If the user already has a scheduled or running request, that request is returned. Requires app_users:erase scope.

post/v2/applications/{application_id}/user_erasures

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/applications/{application_id}/user_erasures
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Path parameters

application_idstring required

Request body

app_user_idstring required

The app user id to erase, exactly as your app identifies it

external_referencestring

Your own reference for the request, e.g. a support ticket id

acknowledge_active_subscriptionsboolean

Erase even though the user has an active subscription billed through your own payment account (e.g. Stripe). Erasure does not cancel it, so the user keeps being charged until you cancel it.

Response

Success

idstring required
object'app_user_erasure' required

Object type, always app_user_erasure

application_idstring required
app_user_idstring nullable required

The app user id to erase. Null once the erasure has completed.

status'scheduled' | 'cancelled' | 'running' | 'completed' required

scheduled until eligible_at (cancellable), then running, then completed

source'api' | 'dashboard' | 'admin' required

Where the request was made

external_referencestring nullable required

Your own reference for the request, e.g. a support ticket id

created_atstring required

ISO 8601 timestamp of the request

eligible_atstring required

ISO 8601 timestamp after which the erasure runs; cancellable until then

cancelled_atstring nullable required
started_atstring nullable required
completed_atstring nullable required

Changes

  • 778a11cd2c15Revision changes
    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new notifications enum value to the // response property for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

  • 7e65bcbd2cceRevision changes
    • info

      endpoint added