Update a Premium | Virtuous Developer Documentation

curl -X PUT https://api.virtuoussoftware.com/api/Premium/premiumId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "<string>",
  "code": "<string>",
  "price": "<double>",
  "fairMarketValue": "<double>",
  "description": "<string>",
  "cost": "<double>",
  "inventoryCount": "<integer>",
  "isActive": "<boolean>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}'

{
  "id": "<integer>",
  "name": "<string>",
  "code": "<string>",
  "description": "<string>",
  "price": "<double>",
  "fairMarketValue": "<double>",
  "cost": "<double>",
  "inventoryCount": "<integer>",
  "isActive": "<boolean>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}

Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only updating a single property, the entire model is still required.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

premiumIdstringRequired

Request

This endpoint expects an object.

namestringOptional

codestringOptional

pricestringOptional

fairMarketValuestringOptional

descriptionstringOptional

coststringOptional

inventoryCountstringOptional

isActivestringOptional

customFieldslist of objectsOptional

Response

idstringOptional

namestringOptional

codestringOptional

descriptionstringOptional

pricestringOptional

fairMarketValuestringOptional

coststringOptional

inventoryCountstringOptional

isActivestringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

customFieldslist of objectsOptional

Errors

400

Bad Request Error