Update Product

PATCH

/products/{object_id}

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (Product)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Product

Example:

Product

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "Product",
        "attributes": {
            "title": "string",
            "isActive": true,
            "productIdentifier": "string",
            "description": "string",
            "shortDescription": "string",
            "purchaseMethod": "product",
            "requirements": [
                {
                    "type": "promoCode",
                    "promoCode": {
                        "prefix": "string",
                        "redemptions": 0
                    },
                    "storeOffer": {
                        "id": "string"
                    }
                }
            ],
            "unlockActions": [
                {
                    "type": "userGroup",
                    "targetId": "string",
                    "accessLevel": "full",
                    "config": {},
                    "fullAccessProductIdentifier": "string"
                }
            ],
            "allowPromoCodes": true
        },
        "relationships": {
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/products/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "Product",
        "attributes": {
            "title": "string",
            "isActive": true,
            "productIdentifier": "string",
            "description": "string",
            "shortDescription": "string",
            "purchaseMethod": "product",
            "requirements": [
                {
                    "type": "promoCode",
                    "promoCode": {
                        "prefix": "string",
                        "redemptions": 0
                    },
                    "storeOffer": {
                        "id": "string"
                    }
                }
            ],
            "unlockActions": [
                {
                    "type": "userGroup",
                    "targetId": "string",
                    "accessLevel": "full",
                    "config": {},
                    "fullAccessProductIdentifier": "string"
                }
            ],
            "allowPromoCodes": true
        },
        "relationships": {
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (Product)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Product

Example:

Product

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "Product",
        "attributes": {
            "title": "string",
            "isActive": true,
            "productIdentifier": "string",
            "description": "string",
            "shortDescription": "string",
            "purchaseMethod": "product",
            "requirements": [
                {
                    "type": "promoCode",
                    "promoCode": {
                        "prefix": "string",
                        "redemptions": 0
                    },
                    "storeOffer": {
                        "id": "string"
                    },
                    "message": "string"
                }
            ],
            "unlockActions": [
                {
                    "type": "userGroup",
                    "targetId": "string",
                    "accessLevel": "full",
                    "config": {},
                    "fullAccessProductIdentifier": "string"
                }
            ],
            "allowPromoCodes": true,
            "amount": 0,
            "priceTag": "string",
            "currency": "string",
            "skuId": "string",
            "checkoutConfig": {
                "type": "chargebee",
                "appId": "string",
                "publicKey": "string"
            },
            "accessDetails": {
                "accessUntilDate": "2019-08-24T14:15:22Z",
                "accessLengthInMonths": 1
            }
        },
        "relationships": {
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-08 10:51:21

Get Product

Delete Product