Skip to main content

Text Field Value

A text field value consists of its value property of type string. The value is plaintext if the type of its corresponding field is single_text and rich-text (HTML) if the field's type is multi_text.

Record creation​

POSThttps://api.tapeapp.com/v1/record/app/{app_id}

A text field value can be created as part of a record creation. Here is an example request body for creating a record with a value for the "First Name" field with ID 1, type single_text and external ID first_name and a value for the "Notes" field with ID 2, type multi_text and external ID notes:

➡️    Request
curl -X POST https://api.tapeapp.com/v1/record/app/1 \
  -u user_key_replace_with_your_api_key: \
  -H "Content-Type: application/json" \
  --data '{
    "fields": {
      "first_name": "Adam Smith",
      "notes": "<p>Registered <b>10</b> month ago.</p>"
    }
  }'
⬅️    Response
{
  "record_id": 1,
  "title": "Adam Smith",
  "fields": [
    {
      "field_Id": 1,
      "external_id": "first_name",
      "type": "text",
      "field_type": "single_text",
      "label": "First Name",
      "values": [{ "value": "Adam Smith" }]
    },
    {
      "field_Id": 2,
      "external_id": "notes",
      "type": "text",
      "field_type": "multi_text",
      "label": "Notes",
      "values": [{ "value": "<p>Registered <b>10</b> month ago.</p>" }]
    }
  ]
}

Record retrieval​

GEThttps://api.tapeapp.com/v1/record/{record_id}

A text field value can be retrieved as part of a record retrieval:

➡️    Request
curl https://api.tapeapp.com/v1/record/1 \
  -u user_key_replace_with_your_api_key:
⬅️    Response
{
  "record_id": 1,
  "title": "Adam Smith",
  "fields": [
    {
      "field_Id": 1,
      "external_id": "first_name",
      "type": "text",
      "field_type": "single_text",
      "label": "First Name",
      "values": [{ "value": "Adam Smith" }]
    },
    {
      "field_Id": 2,
      "external_id": "notes",
      "type": "text",
      "field_type": "multi_text",
      "label": "Notes",
      "values": [{ "value": "<p>Registered <b>10</b> month ago.</p>" }]
    }
  ]
}

Record update​

PUThttps://api.tapeapp.com/v1/record/{record_id}

One or more text field values can be updated as part of a record update. Here is an example request body for updating a record with a value for the "First Name" field with ID 1, type single_text and external ID first_name and a value for the "Notes" field with ID 2, type multi_text and external ID notes:

➡️    Request
curl -X PUT https://api.tapeapp.com/v1/record/1 \
  -u user_key_replace_with_your_api_key: \
  -H "Content-Type: application/json" \
  --data '{
    "fields": {
      "first_name": "Andrea Lim",
      "notes": "<p>Has <b>not</b> registered yet.</p>"
    }
  }'
⬅️    Response
{
  "record_id": 1,
  "title": "Andrea Lim",
  "fields": [
    {
      "field_Id": 1,
      "external_id": "first_name",
      "type": "text",
      "field_type": "single_text",
      "label": "First Name",
      "values": [{ "value": "Andrea Lim" }]
    },
    {
      "field_Id": 2,
      "external_id": "notes",
      "type": "text",
      "field_type": "multi_text",
      "label": "Notes",
      "values": [{ "value": "<p>Has <b>not</b> registered yet.</p>" }]
    }
  ]
}