/merchants/{merchantCode}/images

POST

/merchants/{merchantCode}/images

Uploads an image for use with push notifications

Parameters

Path Parameters

merchantCode

required

string

FormData Parameters

file

required

file

The file to upload. Must be either a .jpg or .png file.

Responses

200

Url of the uploaded file

Media typeapplication/json

object

url

string

Example^generated

{
  "url": "example"
}

400

Validation error

Media typeapplication/json

object

message

string

code

string

error

object

paramName

The parameter-field, that failed to validate, like “userId”

string

paramValue

The value, that was sent, like “xxx”

code

Machine readable error code

string

Allowed values: SCHEMA_VALIDATION_FAILED ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT UNKNOWN_FORMAT PATTERN REQUIRED

message

required

Human readable error code

string

results

object

errors

Array<object>

object

code

Machine readable error code

string

Allowed values: ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT UNKNOWN_FORMAT PATTERN

message

Human readable error code

string

description

string

path

Array<string>

warnings

array

Example

{
  "error": {
    "code": "SCHEMA_VALIDATION_FAILED",
    "results": {
      "errors": [
        {
          "code": "ENUM_MISMATCH",
          "description": "human readable error code"
        }
      ]
    }
  }
}

403

Insufficient permissions

Media typeapplication/json

object

code

Machine readable error code

string

message

required

Human readable error code

string

Example^generated

{
  "code": "example",
  "message": "example"
}

404

Merchant not found

Media typeapplication/json

object

code

Machine readable error code

string

message

required

Human readable error code

string

Example^generated

{
  "code": "example",
  "message": "example"
}