Delete user

Deletes a user

HardDelete:

Default behavior is to mark the user as deleted, which will cause it to be hidden in the application. If a user with the same id is created or updated within the next 7 days, the previously deleted record will be revived with all of its associated event history. Conversely, if a user with the same ID is created after 7 days, a totally new record with no event history will be created. To disable the current record from being revived in the future, set the hardDelete flag to true

delete/v1/users/{identifyId}

Request

Base URL
https://app.aptrinsic.com
Auth
none declared
TypeScript
https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/users/:identifyId/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

identifyIdstring required

User id (from identify call)

Query parameters

hardDeleteboolean

Hard delete, do not revive if created/updated again in 7 day window

Response

Deleted

bodyobject

statusCode'100' | '101' | '102' | '103' | '200' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '226' | '300' | '301' | '302' | '303' | '304' | '305' | '307' | '308' | '400' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '411' | '412' | '413' | '414' | '415' | '416' | '417' | '418' | '419' | '420' | '421' | '422' | '423' | '424' | '426' | '428' | '429' | '431' | '451' | '500' | '501' | '502' | '503' | '504' | '505' | '506' | '507' | '508' | '509' | '510' | '511'

statusCodeValueinteger

Changes

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