Create a Vendor

post

https://{host}/api_gateway/rewards/core/v1/vendor/create

Body Params

name

string

required

Unique name identifier for the video.

code

string

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.

brandId

int32

required

Unique brand ID of the organisation.

type

string

enum

required

Defaults to REWARDS

Type of vendor.

Allowed:

images

array

Object containing details of images associated with the vendor. You can add up to 5 images for a vendor.

images

altText

string

Brief text description of the video.

string

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.

url

string

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

isExternal

boolean

Indicate if the video is from an external source.

videos

array

Object containing details of videos associated with the vendor. You can add up to 2 videos for a vendor.

videos

rank

int32

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

description

string

Description for the vendor. Maximum character limit is 1034.

Responses

Language

Credentials

Basic

base64

URL

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400