---
schema_version: "1"
id: 2cec393e35b218718bc99ca3066e915104b7f9967d5be7afd8d3a6ac52f91d56
title: Wave Collection Pin Input
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/bi_dev_guide_rest/bi_requests_wave_collection_pin_input.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_pin_input.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6b4030adc4064f08ede2a4c38faf4c13f1b56d4e43b97127d4b1018bb191c813
description: The pinning rules for an Analytics collection.
---
# Wave Collection Pin Input

The pinning rules for an Analytics collection.

Properties

<table class="featureTable sort_table" summary="">





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d73340e61">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d73340e64">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d73340e67">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d73340e70">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d73340e73">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d73340e61" data-title="Parameter Name"><samp class="codeph nolang">pinned​For</samp></td>

                  <td class="entry" headers="d73340e64" data-title="Type">ID</td>

                  <td class="entry" headers="d73340e67" data-title="Description">The id of a group, a role, or a user the pinning rule is defined for.</td>

                  <td class="entry" headers="d73340e70" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d73340e73" data-title="Available Version">52.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d73340e61" data-title="Parameter Name"><samp class="codeph nolang">pinned​For​Type</samp></td>

                  <td class="entry" headers="d73340e64" data-title="Type">Connect​Wave​Share​Type​Enum</td>

                  <td class="entry" headers="d73340e67" data-title="Description">The share type for the pinning rule. Valid values are:
                    <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">All​Csp​Users</samp></li>

                      <li class="li"><samp class="codeph nolang">All​Prm​Users</samp></li>

                      <li class="li"><samp class="codeph nolang">Customer​Portal​User</samp></li>

                      <li class="li"><samp class="codeph nolang">Group</samp></li>

                      <li class="li"><samp class="codeph nolang">Organization</samp></li>

                      <li class="li"><samp class="codeph nolang">Partner​User</samp></li>

                      <li class="li"><samp class="codeph nolang">PortalRole</samp></li>

                      <li class="li"><samp class="codeph nolang">Portal​Role​And​Subordinates</samp></li>

                      <li class="li"><samp class="codeph nolang">Role</samp></li>

                      <li class="li"><samp class="codeph nolang">Role​And​Subordinates</samp></li>

                      <li class="li"><samp class="codeph nolang">Role​And​Subordinates​Internal</samp></li>

                      <li class="li"><samp class="codeph nolang">User</samp></li>

                    </ul>
                  </td>

                  <td class="entry" headers="d73340e70" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d73340e73" data-title="Available Version">52.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d73340e61" data-title="Parameter Name"><samp class="codeph nolang">type</samp></td>

                  <td class="entry" headers="d73340e64" data-title="Type">Collection​Pin​Type​Enum</td>

                  <td class="entry" headers="d73340e67" data-title="Description">The type of pinning. Valid values are:
                    <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">All</samp></li>

                      <li class="li"><samp class="codeph nolang">Desktop</samp></li>

                      <li class="li"><samp class="codeph nolang">Mobile</samp></li>

                      <li class="li"><samp class="codeph nolang">None</samp></li>

                    </ul>

                  </td>

                  <td class="entry" headers="d73340e70" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d73340e73" data-title="Available Version">52.0</td>

                </tr>

              </tbody>

            </table>