business

Get customer lifecycle impacts

Preview what archiving, restoring, or deleting up to 100 customers would touch (pass id "organization"): per customer and in total, the active product work, future campaign memberships, and past campaign references each product holds, and why a delete would be refused.

get/api/v1/business/customer-lifecycle-impacts/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/business/customer-lifecycle-impacts/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

id'organization' required

Query parameters

customerIdsstring[] required

The customers' ids (1–1000)

command'archive' | 'restore' | 'delete' required

The change to preview; only delete can be refused by the impact

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

blockedReasonstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.