Delete Usergroup by lookup key

DELETE 
/usergroups/:lookupKey/:lookupValue

Delete a usergroup by a specific lookupKey / lookupId combination. A deleted usergroup will be moved to the Propeller Recycle bin. This means the deleted usergroup can be restored, however, only via the Propeller backoffice.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about usergroup lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

Responses

200

Delete Usergroup 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": [
    "Usergroup deleted"
  ]
}

Delete Usergroup by Id - 200

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

400

Delete Usergroup 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 [ids], key must contain one of the following values: [id,sourceId,]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10006",
    "status": 400,
    "type": "InvalidLookupKey"
  }
}

Delete Usergroup by Id - 400

{
  "error": {
    "code": 10006,
    "messages": [
      "Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10006",
    "status": 400,
    "type": "InvalidLookupKey"
  }
}

404

Delete Usergroup 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": 20006,
    "messages": [
      "Usergroup with id [21317] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20006",
    "status": 404,
    "type": "UsergroupNotFound"
  }
}

Delete Usergroup by Id - 404

{
  "error": {
    "code": 20006,
    "messages": [
      "Usergroup with id [21317] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20006",
    "status": 404,
    "type": "UsergroupNotFound"
  }
}

Loading...