Skip to main content
PUT
https://sandbox.getcollate.io/api
/
v1
/
tables
/
{id}
/
followers
PUT /v1/tables/{id}/followers
from metadata.sdk import configure
from metadata.sdk.entities import Tables

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

table_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
user_id = "user-uuid-here"

# Add a follower
table = Tables.add_followers(table_id, [user_id])
print(f"Followers: {len(table.followers)}")

# Remove a follower
table = Tables.remove_followers(table_id, [user_id])

# Add a vote
table = Tables.add_vote(table_id, vote_type="votedUp")

# Remove a vote
table = Tables.remove_vote(table_id)
{
  "id": "455e3d9d-dbbf-455e-b3be-7191daa825f3",
  "name": "agent_performance_summary",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary",
  "followers": [
    {
      "id": "2e7fc52a-57d3-4c0e-8a90-1b77c5a6b8e4",
      "type": "user",
      "name": "admin"
    }
  ]
}

Followers & Votes

Manage followers and votes for table entities. Followers receive notifications about changes. Votes help surface popular or important tables.

Followers

Add Follower

PUT /v1/tables/{id}/followers
id
string
required
UUID of the table.
id
string
required
UUID of the user to add as a follower (sent as request body string).

Remove Follower

DELETE /v1/tables/{id}/followers/{userId}
id
string
required
UUID of the table.
userId
string
required
UUID of the user to remove.

Votes

Add or Update Vote

PUT /v1/tables/{id}/vote
id
string
required
UUID of the table.
updatedVoteType
string
required
Vote type: votedUp, votedDown, or unVoted.
PUT /v1/tables/{id}/followers
from metadata.sdk import configure
from metadata.sdk.entities import Tables

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

table_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
user_id = "user-uuid-here"

# Add a follower
table = Tables.add_followers(table_id, [user_id])
print(f"Followers: {len(table.followers)}")

# Remove a follower
table = Tables.remove_followers(table_id, [user_id])

# Add a vote
table = Tables.add_vote(table_id, vote_type="votedUp")

# Remove a vote
table = Tables.remove_vote(table_id)
{
  "id": "455e3d9d-dbbf-455e-b3be-7191daa825f3",
  "name": "agent_performance_summary",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary",
  "followers": [
    {
      "id": "2e7fc52a-57d3-4c0e-8a90-1b77c5a6b8e4",
      "type": "user",
      "name": "admin"
    }
  ]
}

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission
404NOT_FOUNDTable or user does not exist