Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Create a Vendor

post/api_gateway/rewards/core/v1/vendor/create

Request body

namestring required

Unique name identifier for the video.

codestring

Unique identification code for the vendor. In case the code is null or not provided, a random, unique code is assigned to the vendor. Maximum character limit is 255.

brandIdinteger required

Unique brand ID of the organisation.

type'REWARDS' required

Type of vendor.

altTextstring

Brief text description of the video.

idstring

Unique ID that is generated when a video is created. This ID is the file_handle for the associated video in the Capillary system. If isExternal is false, then this parameter is required. To add a video, raise a ticket to the support team.

urlstring

Direct link to the video. If isExternal is true, then this parameter is required.

isExternalboolean

Indicate if the video is from an external source.

rankinteger

Assign a rank to the vendor. This can be used for ordering and prioritizing.

descriptionstring

Description for the vendor. Maximum character limit is 1034.

Response

200

OR
OR

Example response

{
  "status": {
    "success": true,
    "code": 5002,
    "message": "Vendor created successfully"
  },
  "vendor": {
    "id": 153,
    "name": "vendor002",
    "brandId": 61,
    "enabled": true,
    "vendorDetails": {
      "value": "********************************************************************************",
      "key": "************************************************"
    },
    "type": "REWARDS",
    "createdBy": 75161973,
    "lastUpdatedBy": 75161973,
    "createdOn": 1749708111000,
    "lastUpdatedOn": 1749708111000,
    "createdOnDateTime": "2025-06-12T06:01:51Z",
    "lastUpdatedOnDateTime": "2025-06-12T06:01:51Z",
    "code": "vendor002"
  }
}