Update Request

Update some properties (assignee and externalIDs) of a request.

Updates request. Not every property is updatable.

put

Path parameters

idstringrequired

Request id

Query parameters

languagestringoptional

Body

application/jsontext/jsonapplication/*+json

idstringoptional

auditobjectoptional

$metaobjectoptional

hrefstringread-onlyoptional

externalIdstring | nullableoptional

namestringoptional

statusstringoptional

errorstring | nullableoptional

fromobjectoptional

requesterobjectoptional

assigneeobjectoptional

toobjectoptional

productobjectoptional

parametersany[]optional

messagesobject[]optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.platform.softwareone.com/public/v1/commerce/requests/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "audit": {},
    "$meta": {},
    "externalId": "text",
    "name": "text",
    "status": "text",
    "error": "text",
    "from": {},
    "requester": {},
    "assignee": {},
    "to": {},
    "product": {},
    "parameters": [],
    "messages": [
      {
        "id": "text",
        "audit": {},
        "$meta": {},
        "visibility": {},
        "account": {},
        "type": "text",
        "content": "text",
        "request": {}
      }
    ]
  }'

application/jsontext/jsonapplication/*+json

200

400

404

200

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "externalId": "text",
  "name": "text",
  "status": "text",
  "error": "text",
  "from": {},
  "requester": {},
  "assignee": {},
  "to": {},
  "product": {},
  "parameters": [],
  "messages": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "visibility": {},
      "account": {},
      "type": "text",
      "content": "text",
      "request": {}
    }
  ]
}

Success