Uploads a banner or product image and returns the generated blob filename plus its CDN preview URL.
POST
/api/hostedpaymentpages/images/upload
deprecated
Requires: HostedPaymentPage.HostedPaymentPages.Update, merchant scope.
Accepts multipart/form-data (max 2 MB, max 4000x4000 pixels; gif, jpg, jpeg, png, or webp). The stored filename is server-generated; place the returned `blobName` in a page's `bannerImage` or `productImageBlobName`. Invalid uploads return a field-attributed 400 validation error.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
multipart/form-data
, required
| Field | Type | Description |
|---|---|---|
File
required |
string (binary) | The uploaded image content. The multipart filename is used only to read the claimed extension for the magic-byte cross-check; it never becomes the stored name. Required: the endpoint rejects a missing file with a field-attributed validation error. |
ExtraProperties
required |
object |
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.