Sign in
Delete Recommendation

Partial update delete recommendation

Update a part of a delete recommendation object.

patch/api/v1/delete_recommendations/{deleteRecommendationID}

Path parameters

deleteRecommendationIDinteger required

ID of the delete recommendation

Request body

idinteger

ID of the delete recommendation

enabledboolean

Whether the associated triggers' rules should be active

urlstring uri

URL of the delete recommendation

organizationstring uri

Organization URL.

queuestring uri

Queue URL.

triggersstring[]

URLs of the associated triggers

Example request

{
  "id": 1244,
  "enabled": true,
  "url": "https://example.rossum.app/api/v1/delete_recommendations/1244",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "triggers": [
    "https://example.rossum.app/api/v1/triggers/500"
  ]
}

Response

OK

idinteger required

ID of the delete recommendation

enabledboolean required

Whether the associated triggers' rules should be active

urlstring uri required

URL of the delete recommendation

organizationstring uri required

Organization URL.

queuestring uri required

Queue URL.

triggersstring[] required

URLs of the associated triggers

Example response

{
  "id": 1244,
  "enabled": true,
  "url": "https://example.rossum.app/api/v1/delete_recommendations/1244",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "triggers": [
    "https://example.rossum.app/api/v1/triggers/500"
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.