**Source URL:** https://limited.veevavault.dev/regulatory/mdl/component-types/pagelink

# Pagelink

**Class:** `metadata`

Represents a page link that navigates users to custom URL or [Custom Page](/custompages) destinations.

Learn about [Page Links in Vault Help](https://platform.veevavault.help/en/lr/42768).

| Attribute | Metadata | Description |
| --- | --- | --- |
| `label` | Type: String **Required** Max length: 40 | UI-friendly string in the Vault's base language. |
| `active` | Type: Boolean | Indicates whether the component is active. |
| `description` | Type: String Max length: 255 | A general description of the page link. |
| `url` | Type: String **Required** Max length: 1500 | Defines the URL link for the page link. Must be the Custom Page URL when creating a page link to a Custom Page. |
| `mode` | Type: Enum **Required** Allowed values: Create; Edit; Copy; View; VaultMobile | Determines which action redirects the user to a custom URL or Custom Page. |
| `page_type` | Type: Enum **Required** Allowed values: Object | Specifies the type of page link. `Object` is the only allowed value at this time. |
| `object` | Type: Component | Specifies the object that the page link will override behavior for. |
| `page` | Type: Component | Reference to a Custom Page. For example, `Page.hello_world__c`. Required to create a page link to a Custom Page. |
| `disable_type_select` | Type: Boolean | If set to `true`, Vault bypasses the Object Type select dialog when a user creates a Page Link in the Vault Admin UI. If omitted, the default value is `false`. This attribute can only be set in `CREATE` commands. |

### Supported Operations

| Operation | Support |
| --- | --- |
| Create | Yes |
| Recreate | Yes |
| Alter | Yes |
| Drop | Yes |
| Rename | Yes |
| Describe | Yes |
| Generate Recreate | Yes |
| Queryable | No |

---

**Previous:** [Pagelayout](/regulatory/mdl/component-types/pagelayout)  
**Next:** [Permissionset](/regulatory/mdl/component-types/permissionset)