User Offboarding Flow - PFM

An user offboarding request can be submitted, which results in a PUT request on the Partner API’s in order to trigger the required flow.

PFM users can be removed right away, as no user data is stored.

Close user account

Update the user status to CLOSED by executing a request to PUT {{base_url}}/users/v1/users/{{userId}}/status.

Provide the id received on user creation as {{userId}} in the request path.

Sample request:

--header 'Authorization: Bearer <access_token>'
--header 'Content-Type: application/json' 
--data-raw '{ "status": "CLOSED" }'

Sample response:

{ "data": 
 { "user": { 
 "id": "469d13b6-c0ee-451d-a758-dbf77a6fe368", 
 "partnerUserId": "962b1134-04b6-43fe-b685-91f3acd5b9b7",
 "locale": "es-ES", 
 "status": "CLOSED",
 "createdAt": "2022-06-13T12:22:57.644693Z",
 "updatedAt": "2022-06-13T12:23:57.644693Z",
 "referralCode": "<string>" } 
 }
}