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

parametersobject[]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": {
      "created": {
        "at": "2025-04-01T21:41:40.201Z",
        "by": "[Circular Reference]"
      },
      "updated": {
        "at": "2025-04-01T21:41:40.201Z",
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "externalId": "text",
    "name": "text",
    "status": "text",
    "error": "text",
    "from": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-04-01T21:41:40.201Z",
          "by": "[Circular Reference]"
        },
        "updated": {
          "at": "2025-04-01T21:41:40.201Z",
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        "[Circular Reference]"
      ]
    },
    "requester": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]",
        "invitationAcceptedAt": "2025-04-01T21:41:40.201Z"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "email": "text",
      "status": "text",
      "phone": {
        "prefix": "text",
        "number": "text"
      },
      "firstName": "text",
      "lastName": "text",
      "lastLoginAt": "2025-04-01T21:41:40.201Z",
      "settings": {
        "cultureCode": "text",
        "languageCode": "text"
      },
      "name": "text",
      "accounts": [
        "[Circular Reference]"
      ],
      "currentAccount": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-04-01T21:41:40.201Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-04-01T21:41:40.201Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "[e-mail]",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": "[Circular Reference]"
      }
    },
    "assignee": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]",
        "invitationAcceptedAt": "2025-04-01T21:41:40.201Z"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "email": "text",
      "status": "text",
      "phone": {
        "prefix": "text",
        "number": "text"
      },
      "firstName": "text",
      "lastName": "text",
      "lastLoginAt": "2025-04-01T21:41:40.201Z",
      "settings": {
        "cultureCode": "text",
        "languageCode": "text"
      },
      "name": "text",
      "accounts": [
        "[Circular Reference]"
      ],
      "currentAccount": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-04-01T21:41:40.201Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-04-01T21:41:40.201Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "[e-mail]",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": "[Circular Reference]"
      }
    },
    "to": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-04-01T21:41:40.201Z",
          "by": "[Circular Reference]"
        },
        "updated": {
          "at": "2025-04-01T21:41:40.201Z",
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        "[Circular Reference]"
      ]
    },
    "product": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]",
        "published": "[Circular Reference]",
        "pending": "[Circular Reference]",
        "unpublished": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "shortDescription": "text",
      "longDescription": "text",
      "externalIds": {
        "operations": "text"
      },
      "website": "text",
      "status": "text",
      "vendor": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-04-01T21:41:40.201Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-04-01T21:41:40.201Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "[e-mail]",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": "[Circular Reference]"
      },
      "settings": {
        "productOrdering": true,
        "productRequests": {
          "enabled": true,
          "name": "text",
          "label": "text"
        },
        "itemSelection": true,
        "orderQueueChanges": true,
        "preValidation": {
          "purchaseOrderDraft": true,
          "purchaseOrderQuerying": true,
          "changeOrderDraft": true,
          "terminationOrder": true,
          "productRequest": true
        },
        "splitBilling": {
          "enabled": true,
          "type": "text"
        }
      },
      "statistics": {
        "itemCount": 1,
        "ordersPlacedCount": 1,
        "agreementCount": 1,
        "subscriptionCount": 1,
        "requestCount": 1
      }
    },
    "parameters": [
      {
        "id": "text",
        "audit": "[Circular Reference]",
        "externalId": "text",
        "title": "text",
        "description": "text",
        "value": "text",
        "displayOrder": 1,
        "constraints": {
          "isReadonly": true,
          "isOptional": true
        },
        "typeOptions": null,
        "errorMessage": "text",
        "errorCode": "text",
        "request": "[Circular Reference]"
      }
    ],
    "messages": [
      {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "visibility": {
          "client": true,
          "operations": true,
          "vendor": true
        },
        "account": "[Circular Reference]",
        "type": "text",
        "content": "text",
        "request": "[Circular Reference]"
      }
    ]
  }'

application/jsontext/jsonapplication/*+json

200

400

404

200

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-04-01T21:41:40.201Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-04-01T21:41:40.201Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "externalId": "text",
  "name": "text",
  "status": "text",
  "error": "text",
  "from": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-04-01T21:41:40.201Z",
        "by": "[Circular Reference]"
      },
      "updated": {
        "at": "2025-04-01T21:41:40.201Z",
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "[e-mail]",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      "[Circular Reference]"
    ]
  },
  "requester": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]",
      "invitationAcceptedAt": "2025-04-01T21:41:40.201Z"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "email": "text",
    "status": "text",
    "phone": {
      "prefix": "text",
      "number": "text"
    },
    "firstName": "text",
    "lastName": "text",
    "lastLoginAt": "2025-04-01T21:41:40.201Z",
    "settings": {
      "cultureCode": "text",
      "languageCode": "text"
    },
    "name": "text",
    "accounts": [
      "[Circular Reference]"
    ],
    "currentAccount": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-04-01T21:41:40.201Z",
          "by": "[Circular Reference]"
        },
        "updated": {
          "at": "2025-04-01T21:41:40.201Z",
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": "[Circular Reference]"
    }
  },
  "assignee": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]",
      "invitationAcceptedAt": "2025-04-01T21:41:40.201Z"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "email": "text",
    "status": "text",
    "phone": {
      "prefix": "text",
      "number": "text"
    },
    "firstName": "text",
    "lastName": "text",
    "lastLoginAt": "2025-04-01T21:41:40.201Z",
    "settings": {
      "cultureCode": "text",
      "languageCode": "text"
    },
    "name": "text",
    "accounts": [
      "[Circular Reference]"
    ],
    "currentAccount": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-04-01T21:41:40.201Z",
          "by": "[Circular Reference]"
        },
        "updated": {
          "at": "2025-04-01T21:41:40.201Z",
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": "[Circular Reference]"
    }
  },
  "to": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-04-01T21:41:40.201Z",
        "by": "[Circular Reference]"
      },
      "updated": {
        "at": "2025-04-01T21:41:40.201Z",
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "[e-mail]",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      "[Circular Reference]"
    ]
  },
  "product": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]",
      "published": "[Circular Reference]",
      "pending": "[Circular Reference]",
      "unpublished": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "shortDescription": "text",
    "longDescription": "text",
    "externalIds": {
      "operations": "text"
    },
    "website": "text",
    "status": "text",
    "vendor": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-04-01T21:41:40.201Z",
          "by": "[Circular Reference]"
        },
        "updated": {
          "at": "2025-04-01T21:41:40.201Z",
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[e-mail]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": "[Circular Reference]"
    },
    "settings": {
      "productOrdering": true,
      "productRequests": {
        "enabled": true,
        "name": "text",
        "label": "text"
      },
      "itemSelection": true,
      "orderQueueChanges": true,
      "preValidation": {
        "purchaseOrderDraft": true,
        "purchaseOrderQuerying": true,
        "changeOrderDraft": true,
        "terminationOrder": true,
        "productRequest": true
      },
      "splitBilling": {
        "enabled": true,
        "type": "text"
      }
    },
    "statistics": {
      "itemCount": 1,
      "ordersPlacedCount": 1,
      "agreementCount": 1,
      "subscriptionCount": 1,
      "requestCount": 1
    }
  },
  "parameters": [
    {
      "id": "text",
      "audit": "[Circular Reference]",
      "externalId": "text",
      "title": "text",
      "description": "text",
      "value": "text",
      "displayOrder": 1,
      "constraints": {
        "isReadonly": true,
        "isOptional": true
      },
      "typeOptions": null,
      "errorMessage": "text",
      "errorCode": "text",
      "request": "[Circular Reference]"
    }
  ],
  "messages": [
    {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "visibility": {
        "client": true,
        "operations": true,
        "vendor": true
      },
      "account": "[Circular Reference]",
      "type": "text",
      "content": "text",
      "request": "[Circular Reference]"
    }
  ]
}

OK