> ## Documentation Index
> Fetch the complete documentation index at: https://doc.extole.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Mark custom reward redeemed

> Marks the custom reward as redeemed by the participant.



## OpenAPI

````yaml /api-reference/integration-server-to-extole.json post /v2/rewards/custom-reward/{reward_id}/redeemed
openapi: 3.0.1
info:
  description: >-
    Server-to-Extole integration endpoints: event submission, person lookup,
    zone rendering, token management, and reward retrieval for backend services
    authenticating with client credentials.
  title: Integration API - Server to Extole
  version: '1.0'
servers:
  - description: Production
    url: https://api.extole.io
security:
  - HEADER: []
  - QUERY: []
  - COOKIE: []
tags:
  - name: Authentication
  - name: Batch Jobs
  - name: Events
  - name: Files
  - name: Persons
  - name: Reward Suppliers
  - name: Rewards
  - name: SFTP Servers
  - name: Zone Rendering
paths:
  /v2/rewards/custom-reward/{reward_id}/redeemed:
    post:
      tags:
        - Reward Suppliers
      summary: Mark custom reward redeemed
      description: Marks the custom reward as redeemed by the participant.
      operationId: redeemCustomReward
      parameters:
        - in: path
          name: reward_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            example:
              message: message
              partner_reward_redeem_id: partner_reward_redeem_id
            schema:
              $ref: '#/components/schemas/RedeemedRewardRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RewardResponse'
          description: Successful response
        '400':
          content:
            application/json:
              examples:
                binding_error:
                  $ref: '#/components/examples/binding_error'
                invalid_json:
                  $ref: '#/components/examples/invalid_json'
                invalid_parameter:
                  $ref: '#/components/examples/invalid_parameter'
                missing_request_body:
                  $ref: '#/components/examples/missing_request_body'
                period_count_invalid:
                  $ref: '#/components/examples/period_count_invalid'
                period_not_supported:
                  $ref: '#/components/examples/period_not_supported'
                retry_claimed_reward_not_allowed:
                  $ref: '#/components/examples/retry_claimed_reward_not_allowed'
                reward_illegal_state_transition:
                  $ref: '#/components/examples/reward_illegal_state_transition'
                reward_in_not_retryable_state:
                  $ref: '#/components/examples/reward_in_not_retryable_state'
                reward_not_found:
                  $ref: '#/components/examples/reward_not_found'
                reward_retry_not_supported:
                  $ref: '#/components/examples/reward_retry_not_supported'
                reward_state_invalid:
                  $ref: '#/components/examples/reward_state_invalid'
                reward_supplier_not_found:
                  $ref: '#/components/examples/reward_supplier_not_found'
                reward_type_not_supported:
                  $ref: '#/components/examples/reward_type_not_supported'
                sandbox_not_found:
                  $ref: '#/components/examples/sandbox_not_found'
                time_interval_invalid:
                  $ref: '#/components/examples/time_interval_invalid'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              examples:
                method_unauthorized:
                  $ref: '#/components/examples/method_unauthorized'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Unauthorized
        '402':
          content:
            application/json:
              examples:
                payment_required:
                  $ref: '#/components/examples/payment_required'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Payment Required
        '403':
          content:
            application/json:
              examples:
                access_denied:
                  $ref: '#/components/examples/access_denied'
                method_unauthorized:
                  $ref: '#/components/examples/method_unauthorized'
                missing_access_token:
                  $ref: '#/components/examples/missing_access_token'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Forbidden
        '415':
          content:
            application/json:
              examples:
                unsupported_media_type:
                  $ref: '#/components/examples/unsupported_media_type'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Unsupported Media Type
        '429':
          content:
            application/json:
              examples:
                too_many_requests:
                  $ref: '#/components/examples/too_many_requests'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Too Many Requests
components:
  schemas:
    RedeemedRewardRequest:
      properties:
        message:
          nullable: true
          type: string
        partner_reward_redeem_id:
          nullable: true
          type: string
      required:
        - message
        - partner_reward_redeem_id
      type: object
    RewardResponse:
      properties:
        action_id:
          description: Extole action id associated with this reward.
          type: string
        campaign_id:
          description: Extole campaign id associated with this reward.
          type: string
        cause_event_id:
          description: Id of the direct cause event that triggered this reward.
          type: string
        container:
          description: Campaign container the reward belongs to.
          type: string
        created_at:
          $ref: '#/components/schemas/ZonedDateTime'
        data:
          additionalProperties:
            description: Named data parameters attached to this reward.
            type: string
          description: Named data parameters attached to this reward.
          type: object
        email:
          description: Email address of the reward recipient. Null if not available.
          nullable: true
          type: string
        expires_at:
          $ref: '#/components/schemas/ZonedDateTime'
        face_value:
          description: Monetary or point face value of the reward.
          type: number
        face_value_type:
          description: Unit type of the face value (e.g. `CASH`, `POINTS`, `PERCENT`).
          enum:
            - AUD
            - BRL
            - CAD
            - CNY
            - EUR
            - GBP
            - HKD
            - INR
            - JPY
            - KRW
            - MONTH
            - MXN
            - NZD
            - PERCENT_OFF
            - POINTS
            - TRY
            - TWD
            - USD
          type: string
        journey_key:
          $ref: '#/components/schemas/JourneyKey'
        journey_name:
          description: Name of the journey associated with this reward.
          type: string
        partner_reward_id:
          description: >-
            Partner-assigned identifier for this reward. Null if not yet
            assigned.
          nullable: true
          type: string
        partner_reward_key_type:
          description: Type of key used to identify the reward at the partner's system.
          enum:
            - COUPON
            - ID
            - LINK
          type: string
        partner_reward_supplier_id:
          description: >-
            Partner-assigned identifier for the reward supplier. Null if not
            provided.
          nullable: true
          type: string
        partner_user_id:
          description: Partner's identifier for the person. Null if not provided.
          nullable: true
          type: string
        person_id:
          description: Extole person id of the reward recipient.
          type: string
        reward_id:
          description: Extole-assigned unique identifier for this reward.
          type: string
        reward_supplier_id:
          description: Extole reward supplier id that issued this reward.
          type: string
        root_event_id:
          description: >-
            Id of the root event that initiated the chain leading to this
            reward.
          type: string
        sandbox:
          description: Sandbox identifier for this reward.
          type: string
        state:
          description: Current lifecycle state of the reward.
          enum:
            - CANCELED
            - EARNED
            - FAILED
            - FULFILLED
            - REDEEMED
            - REVOKED
            - SENT
          type: string
      required:
        - action_id
        - campaign_id
        - cause_event_id
        - container
        - created_at
        - data
        - email
        - expires_at
        - face_value
        - face_value_type
        - journey_key
        - journey_name
        - partner_reward_id
        - partner_reward_key_type
        - partner_reward_supplier_id
        - partner_user_id
        - person_id
        - reward_id
        - reward_supplier_id
        - root_event_id
        - sandbox
        - state
      type: object
    RestExceptionResponse:
      description: Represents the API error response
      properties:
        code:
          description: Specific error code for this error type, documented per endpoint
          type: string
        http_status_code:
          description: >-
            HTTP status code that was returned with this error, useful if client
            get response code
          format: int32
          type: integer
        message:
          description: User readable English description of the error
          type: string
        parameters:
          additionalProperties:
            description: >-
              Attributes related to the error, varies be error code, documented
              per endpoint
            type: object
          description: >-
            Attributes related to the error, varies be error code, documented
            per endpoint
          type: object
        unique_id:
          description: >-
            Unique id associated with this error, useful for discussions with
            Extole
          type: string
      required:
        - code
        - http_status_code
        - message
        - parameters
        - unique_id
      type: object
    ZonedDateTime:
      description: >-
        [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or
        [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4)
        date-time with a numeric [UTC
        offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and
        an optional [IANA
        time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4)
        suffix in square brackets. Precision up to milliseconds.
      example: '2025-10-24T02:00:00-07:00'
      pattern: >-
        ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
      type: string
    JourneyKey:
      properties:
        name:
          type: string
        value:
          type: string
      type: object
  examples:
    binding_error:
      summary: binding_error
      value:
        code: binding_error
        http_status_code: 400
        message: Argument is not of the expected type
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    invalid_json:
      summary: invalid_json
      value:
        code: invalid_json
        http_status_code: 400
        message: JSON is invalid
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    invalid_parameter:
      summary: invalid_parameter
      value:
        code: invalid_parameter
        http_status_code: 400
        message: Parameter is invalid.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    missing_request_body:
      summary: missing_request_body
      value:
        code: missing_request_body
        http_status_code: 400
        message: Missing request body
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    period_count_invalid:
      summary: period_count_invalid
      value:
        code: period_count_invalid
        http_status_code: 400
        message: Invalid period count
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    period_not_supported:
      summary: period_not_supported
      value:
        code: period_not_supported
        http_status_code: 400
        message: Period not supported
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    retry_claimed_reward_not_allowed:
      summary: retry_claimed_reward_not_allowed
      value:
        code: retry_claimed_reward_not_allowed
        http_status_code: 400
        message: Retry for Claimed Reward is not allowed
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    reward_illegal_state_transition:
      summary: reward_illegal_state_transition
      value:
        code: reward_illegal_state_transition
        http_status_code: 400
        message: Reward illegal state transition for current state
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    reward_in_not_retryable_state:
      summary: reward_in_not_retryable_state
      value:
        code: reward_in_not_retryable_state
        http_status_code: 400
        message: Reward is in a not retryable state
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    reward_not_found:
      summary: reward_not_found
      value:
        code: reward_not_found
        http_status_code: 400
        message: Reward not found
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    reward_retry_not_supported:
      summary: reward_retry_not_supported
      value:
        code: reward_retry_not_supported
        http_status_code: 400
        message: Reward retry not supported
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    reward_state_invalid:
      summary: reward_state_invalid
      value:
        code: reward_state_invalid
        http_status_code: 400
        message: Specified reward state type is not supported
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    reward_supplier_not_found:
      summary: reward_supplier_not_found
      value:
        code: reward_supplier_not_found
        http_status_code: 403
        message: Reward supplier not found
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    reward_type_not_supported:
      summary: reward_type_not_supported
      value:
        code: reward_type_not_supported
        http_status_code: 400
        message: Reward type not supported
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    sandbox_not_found:
      summary: sandbox_not_found
      value:
        code: sandbox_not_found
        http_status_code: 400
        message: Unable to find sandbox
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    time_interval_invalid:
      summary: time_interval_invalid
      value:
        code: time_interval_invalid
        http_status_code: 400
        message: Time interval is invalid or not ISO-8601 explicit form
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    method_unauthorized:
      summary: method_unauthorized
      value:
        code: method_unauthorized
        http_status_code: 401
        message: Unauthorized access to this endpoint
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    payment_required:
      summary: payment_required
      value:
        code: payment_required
        http_status_code: 402
        message: The access_token provided is associated with an unpaid account.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    access_denied:
      summary: access_denied
      value:
        code: access_denied
        http_status_code: 403
        message: >-
          The access_token provided is not permitted to access the specified
          resource.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    missing_access_token:
      summary: missing_access_token
      value:
        code: missing_access_token
        http_status_code: 403
        message: No access_token was provided with this request.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    unsupported_media_type:
      summary: unsupported_media_type
      value:
        code: unsupported_media_type
        http_status_code: 415
        message: Request had an unsupported or no media type
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    too_many_requests:
      summary: too_many_requests
      value:
        code: too_many_requests
        http_status_code: 429
        message: >-
          The server is unable to process your request at the moment, please
          retry later.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
  securitySchemes:
    HEADER:
      in: header
      name: Authorization
      type: apiKey
      x-bearer-format: bearer
    QUERY:
      in: query
      name: access_token
      type: apiKey
    COOKIE:
      in: cookie
      name: extole_token
      type: apiKey

````