Delete a user

DELETE 
/users/:userId

This endpoint deletes a user account. It is most commonly used when a user stops being a customer of your platform or in conjunction with a GDPR compliance request. Note that this endpoint only deletes the user's account – not any corresponding workflow logs or other data. To remove that data as part of a compliance request, see our 'Delete User Logs' endpoint

Request

Path Parameters

userId stringrequired

The Id of the user you want to lookup. Returned from the Create User endpoint. Note: you can also use the Embedded user's username in this field.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

success boolean

Default value: true

Example (from schema)

{
  "success": true
}

Result

{ 
    "success": true 
}

401

401

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Unauthorized"
}

Result

{
  "message":"Unauthorized"
}

Loading...