Update follow preferences

PUT

https://api.sureshake.com/v2/directory/{subjectType}/{listingId}/follow-preferences

Path parameters

subjectType
person
or
entity
required

listingId
string
required
format: uuid

Request body JSON

notifyFilings
optional
boolean
notifyMaterialChanges
optional
boolean
notifyTeam
optional
boolean
notifyFunds
optional
boolean
notifyInvestments
optional
boolean
notifyRelationships
optional
boolean
notifyCriteria
optional
boolean
notifyPackages
optional
boolean
notifyCorrections
optional
boolean

Returns

200

Default Response

JSON

data
object
required
- listingId
  string
  required
  format: uuid
- subjectType
  person
  or
  entity
  required
- preferences
  object
  required
  notifyFilings
  boolean
  required
  notifyMaterialChanges
  boolean
  required
  notifyTeam
  boolean
  required
  notifyFunds
  boolean
  required
  notifyInvestments
  boolean
  required
  notifyRelationships
  boolean
  required
  notifyCriteria
  boolean
  required
  notifyPackages
  boolean
  required
  notifyCorrections
  boolean
  required
- customized
  boolean
  required
- updatedAt
  string
  or null
  required
  format: date-time
}
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
}

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
}

Update follow preferences

curl --request PUT \
  --url 'https://api.sureshake.com/v2/directory/person/<listingId>/follow-preferences' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notifyFilings": true,
  "notifyMaterialChanges": true,
  "notifyTeam": true,
  "notifyFunds": true,
  "notifyInvestments": true,
  "notifyRelationships": true,
  "notifyCriteria": true,
  "notifyPackages": true,
  "notifyCorrections": true
}
'

const url = 'https://api.sureshake.com/v2/directory/person/<listingId>/follow-preferences';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    notifyFilings: true,
    notifyMaterialChanges: true,
    notifyTeam: true,
    notifyFunds: true,
    notifyInvestments: true,
    notifyRelationships: true,
    notifyCriteria: true,
    notifyPackages: true,
    notifyCorrections: true
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.sureshake.com/v2/directory/person/<listingId>/follow-preferences"

payload = {
    "notifyFilings": True,
    "notifyMaterialChanges": True,
    "notifyTeam": True,
    "notifyFunds": True,
    "notifyInvestments": True,
    "notifyRelationships": True,
    "notifyCriteria": True,
    "notifyPackages": True,
    "notifyCorrections": True
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "data": {
    "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
    "subjectType": "person",
    "preferences": {
      "notifyFilings": true,
      "notifyMaterialChanges": true,
      "notifyTeam": true,
      "notifyFunds": true,
      "notifyInvestments": true,
      "notifyRelationships": true,
      "notifyCriteria": true,
      "notifyPackages": true,
      "notifyCorrections": true
    },
    "customized": true,
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}