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

# Reward Assignment Object

<div class="prose dark:prose-invert custom-html">
  <h2 id="reward-assignment">Reward Assignment</h2>
  <p>All of:</p>

  <ol>
    <li>
      <a href="#reward-assignment-base">Reward Assignment Base</a>
    </li>

    <li>
      <a href="#digital-or-material-reward---parameters">Digital or Material Reward - Parameters</a>
    </li>
  </ol>

  <h2 id="reward-assignment-base">Reward Assignment Base</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            id

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Unique reward assignment ID, assigned by Voucherify.</p>

          <p>
            <strong>Example:</strong>
            rewa\_PbIRoMXpwe5QhobW4JKu0VjH
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            reward\_id

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Associated reward ID.</p>

          <p>
            <strong>Example:</strong>
            rew\_C7wS9eHFDN4CIbXI5PpLSkGY
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            created\_at

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Timestamp representing the date and time when the reward assignment was created. The value is shown in the ISO 8601 format.</p>

          <p>
            <strong>Example:</strong>
            2022-08-11T14:49:22.586Z
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            updated\_at

            <br />

            <code>string</code>,
            <code>null</code>
          </p>
        </td>

        <td>
          <p>Timestamp representing the date and time when the reward assignment was updated. The value is shown in the ISO 8601 format.</p>

          <p>
            <strong>Example:</strong>
            2022-08-11T16:01:34.885Z
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            object

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>The type of the object represented by the JSON. This object stores information about the reward assignment.</p>

          <p>
            Available values:
            <code>reward\_assignment</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            related\_object\_id

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Related object ID to which the reward was assigned.</p>

          <p>
            <strong>Example:</strong>
            camp\_wciTvaOfYmAa3EmIIW3QpXXZ
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            related\_object\_type

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Related object type to which the reward was assigned.</p>

          <p>
            Available values:
            <code>campaign</code>
          </p>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="digital-or-material-reward---parameters">Digital or Material Reward - Parameters</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            parameters

            <br />

            <code>object</code>
          </p>
        </td>

        <td>
          <p>Defines the cost of the reward.</p>

          <table>
            <thead>
              <tr>
                <th>Attributes</th>
                <th>Description</th>
              </tr>
            </thead>

            <tbody>
              <tr>
                <td>
                  <p>
                    loyalty

                    <br />

                    <code>object</code>
                  </p>
                </td>

                <td>
                  <p>Defines the equivalent points value of the reward.</p>

                  <table>
                    <thead>
                      <tr>
                        <th>Attributes</th>
                        <th>Description</th>
                      </tr>
                    </thead>

                    <tbody>
                      <tr>
                        <td>
                          <p>
                            points

                            <br />

                            <code>integer</code>
                          </p>
                        </td>

                        <td>
                          <p>The number of points required to redeem the reward.</p>
                        </td>
                      </tr>

                      <tr>
                        <td>
                          <p>
                            auto\_redeem

                            <br />

                            <code>boolean</code>,
                            <code>null</code>
                          </p>
                        </td>

                        <td>
                          <p>
                            Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value
                            <code>true</code>
                            means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value
                            <code>true</code>.
                          </p>
                        </td>
                      </tr>
                    </tbody>
                  </table>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>
    </tbody>
  </table>
</div>
