# Update Points Redemption Method ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/managers/loyalty-program/points-redemption/update: post: summary: Update Points Redemption Method deprecated: false description: >- Updates the details of an existing redemption method within a store's loyalty program. `loyalty_program.read_write` - Loyalty Program Read & Write operationId: post-managers-loyalty-program-points-redemption-update tags: - Default module/Apps/Merchant APIs/Marketing/Loyalty Program - Loyalty Program parameters: - name: Authorization in: header description: >- The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API. required: true example: '{{Autherization}}' schema: type: string - name: X-Manager-Token in: header description: >- This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The `X-Manager-Token` should be included in the header of API requests that require store-related information. required: false example: '{{Access-Token}}' schema: type: string - name: Accept in: header description: >- Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format. required: true example: application/json schema: type: string default: application/json - name: Accept-Language in: header description: >- Preferred language for the response. Defaults to `en` if not specified. required: false example: en schema: type: string enum: - en - ar examples: - en requestBody: content: multipart/form-data: schema: type: object properties: ruleId: example: 4890974d-d474-4d08-99a4-a42b856ea71a type: string config[type]: type: string enum: - percentage_discount_settings - fixed_rate_settings x-apidog-enum: - value: percentage_discount_settings name: '' description: '' - value: fixed_rate_settings name: '' description: '' example: percentage_discount_settings config[discount]: type: integer example: 5 config[points]: type: integer example: 5 required: - ruleId - config[type] - config[discount] - config[points] examples: {} responses: '200': description: The redemption method is updated successfully. content: application/json: schema: type: object x-examples: Example 1: status: object points_redemption: status: true message: Point redemption method updated successfully message: type: object code: null name: null description: null properties: status: type: string description: Indicates the overall status of the API response. points_redemption: type: object description: >- Provides information related to the updating of the point redemption method. properties: status: type: boolean description: Indicates the status of point redemption method. default: true message: type: string description: >- A confirmation message that indicates the point redemption method has been successfully updated. examples: - Point redemption method updated successfully x-apidog-orders: - status - message x-apidog-ignore-properties: [] message: type: object description: Contains detailed information about the message. properties: type: type: string description: Specifies the type of message. code: type: 'null' description: A specific code representing the message type. name: type: 'null' description: A short, human-readable title or name for the message. description: type: 'null' description: >- A detailed description of the message, providing more context. x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] x-apidog-orders: - status - points_redemption - message x-apidog-ignore-properties: [] example: status: object points_redemption: status: true message: Point redemption method updated successfully message: type: object code: MSG_POPUP_OK name: Points redemption description: Point redemption method updated successfully headers: {} x-apidog-name: OK '401': description: '' content: application/json: schema: type: object description: >- Response returned when the request cannot be authenticated because the required credentials are missing, invalid, or expired. properties: status: type: string description: Indicates the overall status of the API response. examples: - error message: type: object description: >- Contains structured details explaining why the request could not be authenticated. properties: type: type: string description: Indicates the category of the response message. examples: - error code: type: string description: >- A machine-readable code identifying the authentication error. Returns null when no specific code is available. examples: - UNAUTHORIZED nullable: true name: type: string description: >- A short, human-readable title describing the authentication error. Returns null when no title is available. examples: - Unauthorized nullable: true description: type: string description: >- A human-readable explanation of why the request could not be authenticated. Returns null when no detailed explanation is available. examples: - >- Authentication credentials are missing, invalid, or expired. nullable: true required: - type - code - name - description x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] required: - status - message x-apidog-orders: - status - message examples: - status: error message: type: error code: UNAUTHORIZED name: Unauthorized description: >- Authentication credentials are missing, invalid, or expired. x-apidog-ignore-properties: [] examples: '2': summary: Example 1 value: status: error message: type: error code: ERROR_SESSION_MISSING name: Sorry description: Please login first. '3': summary: Example 2 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Login session expired. Please login again. '4': summary: Example 3 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Invalid authentication headers: {} x-apidog-name: Unauthorized '404': description: Not Found content: application/json: schema: type: object x-examples: Example 1: status: error message: type: error code: ERROR_POPUP_OK name: Sorry! description: The Loyalty redemption rule not found properties: status: type: string description: 'Indicates the overall status of the API response. ' examples: - '"error"' message: type: object description: Contains detailed information about the error encountered. properties: type: type: string description: 'Specifies the type of message. ' examples: - '"error"' code: type: string description: A specific code representing the error type. examples: - '"ERROR_POPUP_OK"' name: type: string description: >- A short, human-readable title or name for the error message. examples: - '"Sorry!"' description: type: string description: >- A detailed description of the error, providing more context about what went wrong. examples: - '"The Loyalty redemption rule not found"' x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] x-apidog-orders: - status - message x-apidog-ignore-properties: [] headers: {} x-apidog-name: Record Not Found '500': description: '' content: application/json: schema: type: object properties: status: type: string description: Status of the error. message: $ref: '#/components/schemas/ResponseEnvelopMessage' required: - status - message x-apidog-orders: - status - message x-apidog-ignore-properties: [] example: status: error message: type: error code: MSG_HIDDEN name: Error description: Internal Server Error headers: {} x-apidog-name: Internal Server error security: [] x-apidog-folder: Default module/Apps/Merchant APIs/Marketing/Loyalty Program x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/613905/apis/api-9148633-run components: schemas: ResponseEnvelopMessage: type: object properties: type: type: string description: Type of response message returned by the API. examples: - success code: type: string description: Response code returned by the API, if available. examples: - MSG_POPUP_OK nullable: true name: type: string description: Name or title of the response message, if available. examples: - Coupons nullable: true description: type: string description: Detailed description of the response message, if available. examples: - Coupons created successfully nullable: true required: - type - code - name - description description: Additional response metadata. x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://api.zid.sa/ description: Prod Env security: [] ```