Upload badge template images

Uploads images for badge templates with associated metadata, supporting JPEG and PNG formats with size validation and automatic S3 storage.

POST /api/upload/badgeTemplate/images

Upload badge template images

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/upload/badgeTemplate/images \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --form 'bodyParts={
  "contentDisposition": {
    "attachment": true,
    "charset": {
      "registered": true
    },
    "creationDate": "2023-11-07T05:31:56Z",
    "filename": "<string>",
    "formData": true,
    "inline": true,
    "modificationDate": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "readDate": "2023-11-07T05:31:56Z",
    "size": 123,
    "type": "<string>"
  },
  "entity": {},
  "headers": {
    "empty": true
  },
  "mediaType": {
    "charset": {
      "registered": true
    },
    "concrete": true,
    "parameters": {},
    "qualityValue": 123,
    "subtype": "<string>",
    "subtypeSuffix": "<string>",
    "type": "<string>",
    "wildcardSubtype": true,
    "wildcardType": true
  },
  "messageBodyWorkers": {},
  "parameterizedHeaders": {
    "empty": true
  },
  "parent": {
    "bodyParts": "<array>",
    "contentDisposition": {
      "attachment": true,
      "charset": {
        "registered": true
      },
      "creationDate": "2023-11-07T05:31:56Z",
      "filename": "<string>",
      "formData": true,
      "inline": true,
      "modificationDate": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "readDate": "2023-11-07T05:31:56Z",
      "size": 123,
      "type": "<string>"
    },
    "entity": {},
    "headers": {
      "empty": true
    },
    "mediaType": {
      "charset": {
        "registered": true
      },
      "concrete": true,
      "parameters": {},
      "qualityValue": 123,
      "subtype": "<string>",
      "subtypeSuffix": "<string>",
      "type": "<string>",
      "wildcardSubtype": true,
      "wildcardType": true
    },
    "messageBodyWorkers": {},
    "parameterizedHeaders": {
      "empty": true
    },
    "providers": {}
  },
  "providers": {}
}' \
  --form 'contentDisposition={
  "attachment": true,
  "charset": {
    "registered": true
  },
  "creationDate": "2023-11-07T05:31:56Z",
  "filename": "<string>",
  "formData": true,
  "inline": true,
  "modificationDate": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "readDate": "2023-11-07T05:31:56Z",
  "size": 123,
  "type": "<string>"
}' \
  --form 'entity={}' \
  --form 'fields={}' \
  --form 'headers={
  "empty": true
}' \
  --form 'mediaType={
  "charset": {
    "registered": true
  },
  "concrete": true,
  "parameters": {},
  "qualityValue": 123,
  "subtype": "<string>",
  "subtypeSuffix": "<string>",
  "type": "<string>",
  "wildcardSubtype": true,
  "wildcardType": true
}' \
  --form 'messageBodyWorkers={}' \
  --form 'parameterizedHeaders={
  "empty": true
}' \
  --form 'parent={
  "bodyParts": "<array>",
  "contentDisposition": {
    "attachment": true,
    "charset": {
      "registered": true
    },
    "creationDate": "2023-11-07T05:31:56Z",
    "filename": "<string>",
    "formData": true,
    "inline": true,
    "modificationDate": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "readDate": "2023-11-07T05:31:56Z",
    "size": 123,
    "type": "<string>"
  },
  "entity": {},
  "headers": {
    "empty": true
  },
  "mediaType": {
    "charset": {
      "registered": true
    },
    "concrete": true,
    "parameters": {},
    "qualityValue": 123,
    "subtype": "<string>",
    "subtypeSuffix": "<string>",
    "type": "<string>",
    "wildcardSubtype": true,
    "wildcardType": true
  },
  "messageBodyWorkers": {},
  "parameterizedHeaders": {
    "empty": true
  },
  "providers": {}
}' \
  --form 'providers={}'

200

{
  "allowedMethods": [
    "<string>"
  ],
  "closed": true,
  "cookies": {},
  "date": "2023-11-07T05:31:56Z",
  "entity": {},
  "entityTag": {
    "value": "<string>",
    "weak": true
  },
  "headers": {
    "empty": true
  },
  "language": {
    "country": "<string>",
    "displayCountry": "<string>",
    "displayLanguage": "<string>",
    "displayName": "<string>",
    "displayScript": "<string>",
    "displayVariant": "<string>",
    "extensionKeys": [
      "<string>"
    ],
    "iso3Country": "<string>",
    "iso3Language": "<string>",
    "language": "<string>",
    "script": "<string>",
    "unicodeLocaleAttributes": [
      "<string>"
    ],
    "unicodeLocaleKeys": [
      "<string>"
    ],
    "variant": "<string>"
  },
  "lastModified": "2023-11-07T05:31:56Z",
  "length": 123,
  "links": [
    {
      "params": {},
      "rel": "<string>",
      "rels": [
        "<string>"
      ],
      "title": "<string>",
      "type": "<string>",
      "uri": "<string>",
      "uriBuilder": {}
    }
  ],
  "location": "<string>",
  "mediaType": {
    "charset": {
      "registered": true
    },
    "concrete": true,
    "parameters": {},
    "qualityValue": 123,
    "subtype": "<string>",
    "subtypeSuffix": "<string>",
    "type": "<string>",
    "wildcardSubtype": true,
    "wildcardType": true
  },
  "metadata": {
    "empty": true
  },
  "status": 123,
  "statusInfo": {
    "reasonPhrase": "<string>",
    "statusCode": 123
  },
  "stringHeaders": {
    "empty": true
  }
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

multipart/form-data

bodyParts · (object | null)[] | null

Show child attributes

contentDisposition · object

Show child attributes

entity · object

fields · object

Show child attributes

headers · object

Show child attributes

mediaType · object

Show child attributes

messageBodyWorkers · object

parameterizedHeaders · object

Show child attributes

parent · object

Show child attributes

providers · object

Response

200 - application/json

object | null

OK

allowedMethods · (string | null)[] | null

closed · boolean | null

cookies · object

Show child attributes

date · string<date-time> | null

entity · object

entityTag · object

Show child attributes

headers · object

Show child attributes

language · object

Show child attributes

lastModified · string<date-time> | null

length · integer<int32> | null

links · (object | null)[] | null

Show child attributes

location · string<uri> | null

mediaType · object

Show child attributes

metadata · object

Show child attributes

status · integer<int32> | null

statusInfo · object

Show child attributes

stringHeaders · object

Show child attributes