Update a feature

PUT 
https://euwest.api.elasticpath.com/v2/subscriptions/features/:feature_uuid

Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the feature is not updated. For fields that are optional, an existing value can be removed by specifying a value of null.

Request

Path Parameters

feature_uuid UUIDrequired

The unique identifier of a feature.

application/json

Body

data FeatureUpdaterequired
idUUID (string)required
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
typeSubscriptionFeatureType (string)required
Possible values: [subscription_feature]
Example: subscription_feature
attributes FeatureUpdateAttributesrequired
external_refExternalRefUpdate (string)nullable
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
Possible values: <= 2048 characters
Example: abc123
namestring
The name of the feature.
Possible values: >= 3 characters and <= 1024 characters
Example: Digital library access
descriptionstringnullable
The feature description to display to customers.
Possible values: <= 1024 characters
Example: Access to over 100 ebooks via the digital library.
configuration object
typerequired
Possible values: [access, promotion, usage]
access
tagFeatureTag (string)required
A tag to add to the customer's account when entitled to the feature.
Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9A-Za-z_-]+$
Example: digital_library_access
promotion
promotions FeaturePromotion[]required
Array [
namestringrequired
The name of the feature.
Possible values: >= 3 characters and <= 1024 characters
Example: Digital library access
tagFeatureTag (string)required
A tag to add to the customer's account when entitled to the feature.
Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9A-Za-z_-]+$
Example: digital_library_access
promotion_idUUID (string)
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
]
usage
tagFeatureTag (string)required
A tag to add to the customer's account when entitled to the feature.
Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9A-Za-z_-]+$
Example: digital_library_access
labelstringrequired
The property that has a usage limit.
Possible values: >= 3 characters and <= 1024 characters
Example: Digital downloads
default_valueintegerrequired
The default initial value
Example: 10

Responses

200

Success. The feature details are updated.

application/json

Schema

Schema

data Feature
idUUID (string)
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
typeSubscriptionFeatureType (string)required
Possible values: [subscription_feature]
Example: subscription_feature
attributes FeatureResponseAttributes
external_refExternalRef (string)
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
Possible values: <= 2048 characters
Example: abc123
namestringrequired
The name of the feature.
Possible values: >= 3 characters and <= 1024 characters
Example: Digital library access
descriptionstring
The feature description to display to customers.
Possible values: <= 1024 characters
Example: Access to over 100 ebooks via the digital library.
configuration objectrequired
typerequired
Possible values: [access, promotion, usage]
access
tagFeatureTag (string)required
A tag to add to the customer's account when entitled to the feature.
Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9A-Za-z_-]+$
Example: digital_library_access
promotion
promotions FeaturePromotion[]required
Array [
namestringrequired
The name of the feature.
Possible values: >= 3 characters and <= 1024 characters
Example: Digital library access
tagFeatureTag (string)required
A tag to add to the customer's account when entitled to the feature.
Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9A-Za-z_-]+$
Example: digital_library_access
promotion_idUUID (string)
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
]
usage
tagFeatureTag (string)required
A tag to add to the customer's account when entitled to the feature.
Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9A-Za-z_-]+$
Example: digital_library_access
labelstringrequired
The property that has a usage limit.
Possible values: >= 3 characters and <= 1024 characters
Example: Digital downloads
default_valueintegerrequired
The default initial value
Example: 10
meta FeatureMetarequired
ownerstring<string>required
The owner of a resource, either store or organization.
Example: store
timestamps Timestampsrequired
updated_atstringrequired
The date and time a resource was updated.
Example: 2017-01-10T11:41:19.244842Z
created_atstringrequired
The date and time a resource was created.
Example: 2017-01-10T11:41:19.244842Z

Example (auto)

{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "subscription_feature",
    "attributes": {
      "external_ref": "abc123",
      "name": "Digital library access",
      "description": "Access to over 100 ebooks via the digital library.",
      "configuration": {
        "type": "access",
        "tag": "digital_library_access"
      }
    },
    "meta": {
      "owner": "store",
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      }
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": "400",
      "detail": "data.attributes.name: \"name\" is required"
    }
  ]
}

403

Forbidden. The operation is forbidden on this entity.

application/json

Schema

Schema

errors Error[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Permission denied",
      "status": "404",
      "detail": "Permission denied: plan tenancy mismatch"
    }
  ]
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "No plan found"
    }
  ]
}

409

Write conflict. Unable to perform the operation at this time.

application/json

Schema

Schema

errors Error[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

Example

{
  "errors": [
    {
      "title": "Write Conflict",
      "status": "409"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Authorization: http

name: BearerTokentype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://euwest.api.elasticpath.com/v2/subscriptions/features/:feature_uuid");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"id\": \"11111111-2222-3333-4444-555555555555\",\n    \"type\": \"subscription_feature\",\n    \"attributes\": {\n      \"external_ref\": \"abc123\",\n      \"name\": \"Digital library access\",\n      \"description\": \"Access to over 100 ebooks via the digital library.\",\n      \"configuration\": {\n        \"type\": \"access\",\n        \"tag\": \"digital_library_access\"\n      }\n    }\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com/v2

Auth

Bearer Token

Parameters

feature_uuid — pathrequired

Body

{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "subscription_feature",
    "attributes": {
      "external_ref": "abc123",
      "name": "Digital library access",
      "description": "Access to over 100 ebooks via the digital library.",
      "configuration": {
        "type": "access",
        "tag": "digital_library_access"
      }
    }
  }
}

ResponseClear

Click the Send API Request button above and see the response here!