Record Sharing & Permissions

Records are the place where work gets done inside a Tape organization. Records can be shared and permissions can be changed (removed, added, elevated and restricted) via the developer API.

Batch update multiple records' permissions

NEWPUThttps://api.tapeapp.com/v1/record/permission/batch

To share a record to individual users or update record permissions, issue a PUT request to this endpoint. The PUT body has to contain the inputs property with an array of objects that have a record_id property to specify for which record permissions should be alterered, and arrays add_permissions, update_permissions and remove_permissions.

Optionally specifying add_permissions, each entry must contain either a user_id or an email property for the respective organization user to be added. If there is no user inside the organization that matches email, a new one will be created and an invitation to join Tape will be sent. Additionally, a numeric permission_level needs to be specified.

Optionally specifying update_permissions, each entry must contain either a user_id or an email property for the respective organization user to be added. If there is no user inside the organization that matches email, nothing will happen. A numeric permission_level needs to be specified and will update existing permissions for that user. As opposed to add_permissions, no new invite email will be send, so this is useful to silently update user's permissions.

Valid permission levels to be specified for the permission_level property are:

5 / (full access)
4 / (can share)
3 / (can edit)
2 / (can comment)
1 / (can view)
0 / (no access)

Optionally specifying remove_permissions, each entry must be either a user ID or an email. Access for the respective user will be removed, if it was added prior. This does not affect access that a user might have via workspace memberships or app permissions.

Currently, only for a maximum of 50 records the permissions can be batch updated at the same time. An error will be thrown if the inputs array exceeds that limit. If you need more, issue seperate requests.

cURL
JSON

➡️      Request
curl -X PUT https://api.tapeapp.com/v1/record/permission/batch \
  -u user_key_replace_with_your_api_key: \
  -H "Content-Type: application/json" \
  --data '{
    "inputs": [
      {
        "record_id": 1,
        "add_permissions": [
          {
            "user_id": 100,
            "permission_level": 5
          }
        ],
        "remove_permissions": [101]
      },
      {
        "record_id": 2,
        "add_permissions": [
          {
            "user_id": 100,
            "permission_level": 5
          },
          {
            "email": "[email protected]",
            "permission_level": 4
          },
        ],
        "remove_permissions": [101]
      }
    ]
  }' 

➡️      Request
{
  "inputs": [
    {
      "record_id": 1,
      "add_permissions": [
        {
          "user_id": 100,
          "permission_level": 5
        }
      ],
      "remove_permissions": [101]
    },
    {
      "record_id": 2,
      "add_permissions": [
        {
          "user_id": 100,
          "permission_level": 5
        },
        {
          "email": "[email protected]",
          "permission_level": 4
        }
      ],
      "remove_permissions": [101]
    }
  ]
}

⬅️ Response

{}

The example above alters permissions for two records with id 1 and 2, adding the user with ID 100 two both records gaining full access, and additionally adding a second user gaining access to record with ID 2 via email. The user would be created and invited if there is no user matching the email in the active organization. Further, user with ID 101 is revoked the access two both records.

Batch update multiple records' permissions​

Batch update multiple records' permissions