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

lookupKey stringrequired

Lookup key. Read more about user lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

Responses

200

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

Schema

data

object

object
messages string[]

Example (from schema)

{
  "data": {},
  "messages": [
    "User deleted"
  ]
}

Delete User by Id - 200

{
  "data": {},
  "messages": [
    "User deleted"
  ]
}

400

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

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "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 - 400

{
  "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"
  }
}

404

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

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 70006,
    "messages": [
      "User with sourceId [146991] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/70006",
    "status": 404,
    "type": "UserNotFound"
  }
}

Delete User by Id - 404

{
  "error": {
    "code": 70006,
    "messages": [
      "User with sourceId [146991] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/70006",
    "status": 404,
    "type": "UserNotFound"
  }
}

Loading...