Jump to

• Request
• Response

Update a body end page tag.

put

/ccadmin/v1/sites/{siteId}/bodyEndTags/{tagId}

Update a page tag at the end of the body section of the specified site.

Request

Supported Media Types

• application/json

Path Parameters

• siteId: string
  The ID of the site where the page tag should be embedded
• tagId: string
  The ID of the page tag to update

Body ()

Root Schema : updatePageTag_request

Type: object

Show Source

• content: string
  The page tag HTML
• enabled: boolean
  Whether the page tag should appear in the site's HTML
• id: string
  The page tag ID generated on the server. This must match the pageTag ID in the path and cannot be updated.
• name: integer
  The name of the page tag
• order: integer
  1-based position of the page tag in the page tag list

{
    "properties":{
        "name":{
            "description":"The name of the page tag",
            "type":"integer"
        },
        "id":{
            "description":"The page tag ID generated on the server.  This must match the pageTag ID in the path and cannot be updated.",
            "type":"string"
        },
        "enabled":{
            "description":"Whether the page tag should appear in the site's HTML",
            "type":"boolean"
        },
        "content":{
            "description":"The page tag HTML",
            "type":"string"
        },
        "order":{
            "description":"1-based position of the page tag in the page tag list",
            "type":"integer"
        }
    },
    "required":[
        "id",
        "order",
        "name",
        "enabled",
        "content"
    ],
    "example":{
        "name":"taya tag",
        "id":"8571b3a7-0a74-4516-978c-5090f31d8faf",
        "enabled":true,
        "content":"<script type='text/javascript' src='https//some.other.service.com/taya.js'></script>",
        "order":2
    }
}

Example:

{
    "name":"taya tag",
    "id":"8571b3a7-0a74-4516-978c-5090f31d8faf",
    "enabled":true,
    "content":"<script type='text/javascript' src='https//some.other.service.com/taya.js'></script>",
    "order":2
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The following model is returned when operation succeeds.

Body ()

Root Schema : pageTag_response

Type: object

Show Source

• content(optional): string
  The page tag HTML
• enabled(optional): boolean
  Whether the page tag should appear in the site's HTML
• id(optional): string
  The page tag id generated on the server
• name(optional): integer
  The name of the page tag
• order(optional): integer
  1-based position of the page tag in the page tag list

{
    "properties":{
        "name":{
            "description":"The name of the page tag",
            "type":"integer"
        },
        "id":{
            "description":"The page tag id generated on the server",
            "type":"string"
        },
        "enabled":{
            "description":"Whether the page tag should appear in the site's HTML",
            "type":"boolean"
        },
        "content":{
            "description":"The page tag HTML",
            "type":"string"
        },
        "order":{
            "description":"1-based position of the page tag in the page tag list",
            "type":"integer"
        }
    }
}

Example Response (application/json)

{
    "name":"taya tag",
    "id":"8571b3a7-0a74-4516-978c-5090f31d8faf",
    "enabled":true,
    "content":"",
    "order":2
}

412 Response

ETag mismatch. Asset has been updated by another user.

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |52900|The page tag repository was not initialized.| |529010|The site ID in the path is invalid.| |52902|Missing input.| |52907|Invalid tag ID.| |52910|Invalid Site ID.| |52905|An internal error occurred while updating this page tag.| |52909|Invalid section.| |52908|Invalid name.| |52911|Invalid content.

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top