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
idstringOptional
auditall ofOptional
$metaall of | nullableOptional
namestringOptional
revisioninteger · int32Optional
externalIdstring | nullableOptional
statusstringOptional
errorstring | nullableOptional
fromall ofOptional
requesterall ofOptional
assigneeall ofOptional
toall ofOptional
productall ofOptional
Responses
200

OK

application/json
put
PUT /public/v1/commerce/requests/{id} HTTP/1.1
Host: api.s1.today
Content-Type: application/json
Accept: */*
Content-Length: 1432

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-09-20T14:18:18.024Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2025-09-20T14:18:18.024Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "revision": 1,
  "externalId": "text",
  "status": "text",
  "error": "text",
  "from": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "requester": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "assignee": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "to": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "product": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "status": "text"
  },
  "parameters": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-09-20T14:18:18.024Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2025-09-20T14:18:18.024Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "externalId": "text",
      "title": "text",
      "description": "text",
      "value": "text",
      "displayOrder": 1,
      "constraints": {
        "isReadonly": true,
        "isOptional": true
      },
      "typeOptions": null,
      "errorMessage": "text",
      "errorCode": "text",
      "request": {
        "id": "text",
        "name": "text",
        "revision": 1
      }
    }
  ],
  "messages": [
    {
      "id": "text",
      "revision": 1,
      "visibility": {
        "client": true,
        "operations": true,
        "vendor": true
      },
      "type": "text",
      "content": "text"
    }
  ]
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-09-20T14:18:18.024Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2025-09-20T14:18:18.024Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "revision": 1,
  "externalId": "text",
  "status": "text",
  "error": "text",
  "from": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "requester": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "assignee": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "to": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "product": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "status": "text"
  },
  "parameters": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-09-20T14:18:18.024Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2025-09-20T14:18:18.024Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "externalId": "text",
      "title": "text",
      "description": "text",
      "value": "text",
      "displayOrder": 1,
      "constraints": {
        "isReadonly": true,
        "isOptional": true
      },
      "typeOptions": null,
      "errorMessage": "text",
      "errorCode": "text",
      "request": {
        "id": "text",
        "name": "text",
        "revision": 1
      }
    }
  ],
  "messages": [
    {
      "id": "text",
      "revision": 1,
      "visibility": {
        "client": true,
        "operations": true,
        "vendor": true
      },
      "type": "text",
      "content": "text"
    }
  ]
}

Last updated

Was this helpful?