Delete User by lookup key
DELETE/users/:lookupKey/:lookupValue
Delete a user
by a specific lookupKey / lookupId combination. A deleted user
will be moved to the Propeller Recycle bin. This means the deleted user can be restored, however, only via the Propeller backoffice.
Request
Path Parameters
Lookup key. Read more about user lookup keys
The value of the key (id or sourceId)
Responses
- 200
- 400
- 404
Delete User by Id - 200
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Delete User by Id - 200
Schema
data
object
{
"data": {},
"messages": [
"User deleted"
]
}
{
"data": {},
"messages": [
"User deleted"
]
}
Delete User by Id - 400
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Delete User by Id - 400
Schema
error
object
{
"error": {
"code": 10006,
"messages": [
"Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"
],
"moreInfo": "https://www.propel.us/docs/errors/10006",
"status": 400,
"type": "InvalidLookupKey"
}
}
{
"error": {
"code": 10006,
"messages": [
"Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"
],
"moreInfo": "https://www.propel.us/docs/errors/10006",
"status": 400,
"type": "InvalidLookupKey"
}
}
Delete User by Id - 404
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Delete User by Id - 404
Schema
error
object
{
"error": {
"code": 70006,
"messages": [
"User with sourceId [146991] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/70006",
"status": 404,
"type": "UserNotFound"
}
}
{
"error": {
"code": 70006,
"messages": [
"User with sourceId [146991] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/70006",
"status": 404,
"type": "UserNotFound"
}
}