Users API

The Users API allows you to manage user data.

Specifications

Delete user identity

DELETE /{environment}/users/{user_id}

Description

Removes the given user id (or device id) from Froomle’s systems. Events related to this user will remain in our system, but will no longer be tied to this user identity. Should you reuse this user id it will be treated as a new user.

Parameters

Type Name Schema

Path

environment
required

string

Path

user_id
required

string

Responses

HTTP Code Description Schema

200

User references were succesfully deleted

No Content

401

Access token is missing or invalid

No Content

404

The user id is not yet known in the system

No Content

cURL Example

$ curl --location --request DELETE 'https://{customer_token}.froomle.com/api/{environment}/users/{user_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer X'