Productsup
API referenceV1Export template attribute

Update an export template attribute

An export template attribute is a field that belongs to an export template. Once created, the export template attribute will be added to every channel that is created from the export template in the productsup platform. This endpoint allows the updating of an existing export template attribute.

PATCH
/V1/export-templates/{templateId}/attributes/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

ProductsUp Keycloak JWT bearer token.

In: header

Path Parameters

templateId*string

Export template id.

id*string

Export Template Attribute id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://export-template-api.productsup.com/V1/export-templates/string/attributes/string" \  -H "Content-Type: application/json" \  -d '{    "alias": "title",    "mandatory": true,    "type": "optional",    "conditions": [],    "flag": "not hidden",    "isDefaultTrackingColumn": true,    "isUniqueColumn": true,    "order": 10,    "deltaIgnore": true,    "deltaKey": true,    "automapIgnore": true,    "description": "a new product title",    "format": "String (Unicode Characters)",    "examples": [      "some example"    ]  }'
{
  "data": {
    "id": 995992,
    "alias": "title",
    "mandatory": true,
    "type": "optional",
    "conditions": [],
    "flag": "not hidden",
    "isDefaultTrackingColumn": true,
    "isUniqueColumn": true,
    "order": 10,
    "deltaIgnore": true,
    "deltaKey": true,
    "automapIgnore": true,
    "description": "a new product title",
    "format": "String (Unicode Characters)",
    "export": {
      "id": 58965
    },
    "fieldTags": [],
    "analyzerTestExports": [],
    "fieldname": "test",
    "examples": [
      "some example"
    ]
  }
}
{
  "errors": {
    "message": "Request validation has encountered constraint violations.",
    "errors": {
      "fieldName": [
        "This field was not expected."
      ]
    }
  }
}
{
  "errors": {
    "message": "Resource access denied."
  }
}

How is this guide?

Delete an export template attribute DELETE

Delete an export template attribute. Only if a field is non mandatory. Only internal users and admins can remove fields from global channels

Retrieves a list of export template attributes of an export template GET

An export template attribute is a field that belongs to an export template. Once created, the export template attribute will be added to every channel that is created from the export template in the productsup platform. This endpoint lists all export template attributes of an export template, including their V2 analyzer test template assignments.