Upload Coupons (Batch)

Path parameter

ParameterDescription
couponSeriedIdUnique ID of the coupon series for which you need to upload coupons.

Body parameter

ParameterDescription
fileName of the CSV file with customer and coupon details.
customerIdentifierCustomer identifier type used in the CSV file. Use NOT_TAGGED as the identifier to upload only coupon codes.
customerIdentifierColumnColumn ID of the customer identifier in the uploaded CSV file.

Header Required

HeaderDescription
Content-Type*multipart/form-data
x-cap-api-oauth-tokenGenerated authentication token

Response parameter

ParameterDescription
orgIdOrganization ID associated with the result.
couponSeriesIdID of the coupon series.
uploadJobStatuses.jobIdJob ID for the upload status.
uploadJobStatuses.uploadStatusStatus of the upload (e.g., STARTED).
uploadJobStatuses.createdOnTimestamp when the upload job was created.
uploadJobStatuses.updatedOnTimestamp when the upload job was last updated.
uploadJobStatuses.errorFileUrlURL for the error file if any errors occurred during upload.
uploadJobStatuses.successFileUrlURL for the success file if the upload was successful.
uploadJobStatuses.uploadedFileUrlURL of the uploaded file.
uploadJobStatuses.totalUploadedCountTotal number of uploaded rows.
uploadJobStatuses.actualRowCountActual number of rows in the uploaded file.
uploadJobStatuses.errorCountNumber of errors encountered during upload.
uploadJobStatuses.uploadTableNameName of the table where uploaded data is stored.
uploadJobStatuses.uploadedFileNameName of the uploaded file.
uploadJobStatuses.audienceGroupIdID of the audience group.
uploadJobStatuses.audienceGroupVersionIdVersion ID of the audience group.
fileNameName of the file associated with the result.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!