Settings PATCH API Documentation

Purpose

This endpoint allows you to partially update an existing variation by modifying its core attributes (such as name, display_name, or description) or by performing operations on variation options (add, remove, or change). It provides flexibility for maintaining variation structures without recreating them from scratch.

Use Case

Updating the display name or description of a variation.
Reordering or renaming variation options.
Adding new variation options dynamically.
Removing outdated or invalid variation options.

Path Parameters

Parameter	Type	Description
`V_UUID`	String	Unique identifier of the variation to update.

Query Parameters

This endpoint does not have any query parameters.

Request Body

                V2
              

                V3
              

                      {
    "variations": {
        // "name": "",
        // "display_name": "",
        // "description": "hello",
        "options": [
            {
                "name": "Blue",
                "order": 1
                // "uuid": "2b39fcfa-8971-474b-bd78-ec285ebadb8a"
            },
            {
                "name": "Red",
                "order": 2
                // "uuid": "2b39fcfa-8971-474b-bd78-ec285ebadb8a"
            }
        ]
    }
}
                    

                      {
    "variations": {
        "name": "daviddof",
        "display_name": "dimention",
        "description": "Bryan Adams"
        // "options": [
        //     {
        //         "operation": "CHANGE",
        //         "name": "Ultra Pro Maxwell",
        //         "uuid": "c5f86f3b-be72-4268-8b31-e92752438760"
        //     },
        //     {
        //         "operation": "ADD",
        //         "name": "Maxwell"
        //     },
        //     {
        //         "operation": "REMOVE",
        //         "uuid": "c5f86f3b-be72-4268-8b31-e92752438760"
        //     }
        // ]
    }
}
                    

Attribute	Type	Description
`variations`	Object	Main container for variation update details.
`variations.name`	String	Internal system name for the variation (unique).
`variations.display_name`	String	Human-readable name of the variation.
`variations.description`	String	Description providing additional details about the variation.
`variations.options`	Array	List of operations to perform on variation options.
`variations.options[].operation`	String	Operation type: `ADD`, `REMOVE`, or `CHANGE`.
`variations.options[].name`	String	New or updated option name (used with `ADD` or `CHANGE`).
`variations.options[].uuid`	String	Unique identifier of the option to change or remove.

                V2
              

                V3
              

                      {
    "variation": {
        "uuid": "b68a94fb-f666-4a40-88a6-39460336352a",
        "status": "ACTIVE",
        "name": "daviddof",
        "display_name": "dimention",
        "description": "",
        "options": [
            {
                "name": "Ultra Pro Maxwell",
                "uuid": "06a1fdde-6ded-418c-b9a9-5b02219de095"
            },
            {
                "name": "Maxwell",
                "uuid": "1b139be5-e401-434b-9a8b-3be001f86bbd"
            },
            {
                "name": "Mobab",
                "uuid": "35233839-68b8-4738-b820-494d73be8c44"
            },
            {
                "name": "White",
                "uuid": "6bc69ee6-bddf-4b48-9f02-f5d26b552bb4"
            },
            {
                "name": "Red",
                "uuid": "c286caeb-a91b-4766-8d35-acebecd0973d"
            }
        ]
    }
}
                    

                      {
    "variation": {
        "uuid": "b68a94fb-f666-4a40-88a6-39460336352a",
        "status": "ACTIVE",
        "name": "daviddof",
        "display_name": "dimention",
        "description": "Bryan Adams",
        "options": [
            {
                "name": "Maxwell",
                "uuid": "1b139be5-e401-434b-9a8b-3be001f86bbd"
            },
            {
                "name": "Megular",
                "uuid": "6bc69ee6-bddf-4b48-9f02-f5d26b552bb4"
            },
            {
                "name": "Mobab",
                "uuid": "35233839-68b8-4738-b820-494d73be8c44"
            },
            {
                "name": "Qremium",
                "uuid": "c286caeb-a91b-4766-8d35-acebecd0973d"
            },
            {
                "name": "Ultra Pro Maxwell",
                "uuid": "06a1fdde-6ded-418c-b9a9-5b02219de095"
            }
        ]
    }
}
                    

Attribute	Type	Description
`variation`	Object	The updated variation object.
`variation.uuid`	String	Unique identifier of the variation.
`variation.status`	String	Status of the variation.
`variation.name`	String	Internal system name of the variation.
`variation.display_name`	String	Human-readable display name of the variation.
`variation.description`	String	Updated description of the variation.
`variation.options`	Array	List of options available under the variation.
`variation.options[].name`	String	Name of the variation option.
`variation.options[].uuid`	String	Unique identifier of the variation option.

Update a Specific Variation: /settings/variations/{V_UUID}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body