Update viewer groups

PATCH

https://api.sureshake.com/v2/entities/{entityId}/viewer-groups/{groupId}

Path parameters

entityId
string
required
format: uuid

groupId
string
required
format: uuid

Request body JSON

name
optional
string
maxLength: 120 · minLength: 1
platformRole
optional
investor
or
lender
or
buyer
or
advisor
or
founder
or
viewer
+1 more

Returns

200

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- name
  string
  required
- platformRole
  investor
  or
  lender
  or
  buyer
  or
  advisor
  or
  founder
  or
  viewer
  +1 more
  required
- memberCount
  integer
  required
  minimum: 0
- tabCount
  integer
  required
  minimum: 0
- reportCount
  optional
  integer
  minimum: 0 · default: 0
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

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
}

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
}

curl --request PATCH \ --url 'https://api.sureshake.com/v2/entities/<entityId>/viewer-groups/<groupId>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "platformRole": "investor" } '

{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "name": "string", "platformRole": "investor", "memberCount": 0, "tabCount": 0, "reportCount": 0 }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }