Skip to main content

Link Field

There is only type of link field: multi_link.

multi_link fields-values can hold a one or more link entries.

A multi_link field definition consists only of the common field properties and has no settings.

App creation​

POSThttps://api.tapeapp.com/v1/app

A multi_link field can be created as part of an App creation. Here is an example request body for creating an excerpt for a contacts app within a workspace with ID 1. The app contains a multi_link field "Social Media". Other useful fields for a contacts app, like "First Name", "Last Name" or "Notes" are omitted for brevity.

➡️    Request

curl -X POST https://api.tapeapp.com/v1/app/ \
   -u user_key_replace_with_your_api_key: \
   -H "Content-Type: application/json" \
   --data '{
    "workspace_id": 1,
    "name": "Contacts",
    "item_name": "Contact",
    "fields": [
      {
        "field_type": "multi_link",
        "config": {
          "label": "Social Media",
          "description": "The social media profiles of the contact.",
          "required": false
        }
      }
    ] 
  }'
⬅️    Response
{
  "app_id": 1,
  "workspace_id": 1,
  "slug": "contacts",
  "name": "Contacts",
  "item_name": "Contact",
  "position": 0,
  "config": {
    "item_name": "Contact",
    "name": "Contacts"
  },
  "fields": [
    {
      "field_id": 1,
      "external_id": "social_media",
      "slug": "social_media",
      "label": "Social Media",
      "field_type": "multi_link",
      "type": "embed",
      "config": {
        "label": "Social Media",
        "slug": "social_media",
        "description": "The social media profiles of the contact.",
        "required": false,
        "always_hidden": false,
        "hidden_if_empty": false
      }
    }
  ]
}

App update​

PUThttps://api.tapeapp.com/v1/app/{appId}

A multi_link field can be created or updated as part of an App update. Here is an example request body for updating the previously created contacts app with ID 1. The update changes the name of the "Social Media" field to "Social Media Profiles".

➡️    Request

curl -X PUT https://api.tapeapp.com/v1/app/1 \
   -u https://api.tapeapp.com: \
   --data '{
    "app_id": 1,
    "fields": [
      {
        "field_id": 1,
        "config": {
          "label": "Social Media Profiles",
          "description": "The social media profiles of the contact.",
          "required": false
        }
      }
    ] 
  }'
⬅️    Response
{
  "app_id": 1,
  "workspace_id": 1,
  "slug": "contacts",
  "external_id": "contacts",
  "name": "Contacts",
  "record_name": "Contact",
  "item_name": "Contact",
  "position": 0,
  "config": {
    "item_name": "Contact",
    "name": "Contacts"
  },
  "fields": [
    {
      "field_id": 1,
      "external_id": "social_media",
      "slug": "social_media",
      "label": "Social Media Profiles",
      "field_type": "multi_link",
      "type": "embed",
      "config": {
        "label": "Social Media Profiles",
        "slug": "social_media",
        "description": "The social media profiles of the contact.",
        "required": false,
        "always_hidden": false,
        "hidden_if_empty": false
      }
    }
  ]
}```