Grant follow access

PUT

https://api.sureshake.com/v2/entities/{id}/follow-access/policies

Path parameters

id
string
required
format: uuid

Request body JSON

principalType
optional
user
or
entity
or
organization
default: "user"
principalId
optional
string
minLength: 1
followerUserId
optional
string
minLength: 1
artifactPolicyMode
optional
all_reports
or
selector_based
default: "all_reports"
allowedReportTypes
optional
array of
string
minLength: 1 · default: []
allowedDocumentSourceTypes
optional
array of
string
minLength: 1 · default: []
allowedTagIds
optional
array of
string
format: uuid · default: []
allowedReportIds
optional
array of
string
format: uuid · default: []
linkedArtifactAccess
optional
none
or
derived_only
or
full_artifact
default: "derived_only"
profileAccessTier
optional
public
or
follower
or
capital
or
diligence
or
custom
default: "follower"
allowedProfileFields
optional
array of
stage
or
sector
or
geography
or
raiseStatus
or
tractionSummary
or
website
+2 more
default: []

Returns

200

Default Response

JSON

success
boolean
required
policy
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- principalType
  user
  or
  entity
  or
  organization
  required
- principalId
  string
  required
- status
  approved
  or
  revoked
  required
- artifactPolicyMode
  all_reports
  or
  selector_based
  required
- allowedReportTypes
  array of
  string
  required
- allowedDocumentSourceTypes
  array of
  string
  required
- allowedTagIds
  array of
  string
  required
- allowedReportIds
  array of
  string
  required
- linkedArtifactAccess
  none
  or
  derived_only
  or
  full_artifact
  required
- profileAccessTier
  public
  or
  follower
  or
  capital
  or
  diligence
  or
  custom
  required
- allowedProfileFields
  array of
  stage
  or
  sector
  or
  geography
  or
  raiseStatus
  or
  tractionSummary
  or
  website
  +2 more
  required
- grantedByUserId
  string
  required
- grantedAt
  string
  required
- updatedAt
  string
  required
- revokedAt
  string
  or null
  required
- revocationReason
  string
  or null
  required
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

curl --request PUT \ --url 'https://api.sureshake.com/v2/entities/<id>/follow-access/policies' \ --header 'Content-Type: application/json' \ --data ' { "principalType": "user", "principalId": "string", "followerUserId": "string", "artifactPolicyMode": "all_reports", "allowedReportTypes": [], "allowedDocumentSourceTypes": [], "allowedTagIds": [], "allowedReportIds": [], "linkedArtifactAccess": "none", "profileAccessTier": "public", "allowedProfileFields": [] } '

{ "success": true, "policy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "principalType": "user", "principalId": "string", "status": "approved", "artifactPolicyMode": "all_reports", "allowedReportTypes": [ "string" ], "allowedDocumentSourceTypes": [ "string" ], "allowedTagIds": [ "string" ], "allowedReportIds": [ "string" ], "linkedArtifactAccess": "none", "profileAccessTier": "public", "allowedProfileFields": [ "stage" ], "grantedByUserId": "string", "grantedAt": "string", "updatedAt": "string", "revokedAt": "string", "revocationReason": "string" } }