Create follow request

POST

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

Path parameters

subjectType
person
or
entity
required

listingId
string
required
format: uuid

Request body JSON required

idempotencyKey
string
required
maxLength: 255 · minLength: 8
actingPrincipal
optional
object
- principalType
  user
  or
  entity
  or
  organization
  required
- principalId
  string
  required
  maxLength: 255 · minLength: 1
}
requestNote
optional
string
maxLength: 2000
reason
optional
string
maxLength: 2000 · minLength: 3
requestedTier
optional
follower
or
capital
or
diligence
or
custom
desiredObservation
optional
string
maxLength: 2000 · minLength: 3
requestedDurationDays
optional
integer
maximum: 365 · minimum: 1
packageId
optional
string
format: uuid

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- subject
  object
  required
  listingId
  string
  required
  format: uuid
  subjectType
  person
  or
  entity
  required
- actingPrincipal
  object
  required
  principalType
  user
  or
  entity
  or
  organization
  required
  principalId
  string
  required
  maxLength: 255 · minLength: 1
- requestedByUserId
  string
  required
- status
  pending
  or
  approved
  or
  rejected
  or
  cancelled
  required
- requestNote
  string
  or null
  required
- reason
  string
  or null
  required
- requestedTier
  follower
  or
  capital
  or
  diligence
  or
  custom
  or null
  required
- desiredObservation
  string
  or null
  required
- requestedDurationDays
  integer
  or null
  required
  maximum: 365 · minimum: 1
- reviewDecision
  accepted
  or
  narrowed
  or
  declined
  or null
  required
- grantedTier
  follower
  or
  capital
  or
  diligence
  or
  custom
  or null
  required
- grantedDurationDays
  integer
  or null
  required
  maximum: 365 · minimum: 1
- requestedPackageId
  string
  or null
  required
  format: uuid
- reviewedByUserId
  string
  or null
  required
- reviewedAt
  string
  or null
  required
  format: date-time
- decisionNotes
  string
  or null
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  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
}

Create follow request

curl --request POST \
  --url 'https://api.sureshake.com/v2/directory/person/<listingId>/follow-requests' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actingPrincipal": {
    "principalType": "user",
    "principalId": "string"
  },
  "requestNote": "string",
  "reason": "string",
  "requestedTier": "follower",
  "desiredObservation": "string",
  "requestedDurationDays": 1,
  "idempotencyKey": "stringst",
  "packageId": "471cc1d4-ec27-4504-b7c2-949af95662bc"
}
'

const url = 'https://api.sureshake.com/v2/directory/person/<listingId>/follow-requests';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    actingPrincipal: {principalType: 'user', principalId: 'string'},
    requestNote: 'string',
    reason: 'string',
    requestedTier: 'follower',
    desiredObservation: 'string',
    requestedDurationDays: 1,
    idempotencyKey: 'stringst',
    packageId: '471cc1d4-ec27-4504-b7c2-949af95662bc'
  })
};

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-requests"

payload = {
    "actingPrincipal": {
        "principalType": "user",
        "principalId": "string"
    },
    "requestNote": "string",
    "reason": "string",
    "requestedTier": "follower",
    "desiredObservation": "string",
    "requestedDurationDays": 1,
    "idempotencyKey": "stringst",
    "packageId": "471cc1d4-ec27-4504-b7c2-949af95662bc"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "subject": {
      "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
      "subjectType": "person"
    },
    "actingPrincipal": {
      "principalType": "user",
      "principalId": "string"
    },
    "requestedByUserId": "string",
    "status": "pending",
    "requestNote": "string",
    "reason": "string",
    "requestedTier": "follower",
    "desiredObservation": "string",
    "requestedDurationDays": 1,
    "reviewDecision": "accepted",
    "grantedTier": "follower",
    "grantedDurationDays": 1,
    "requestedPackageId": "85666b99-03c1-49db-85ac-b2f8e233aa9c",
    "reviewedByUserId": "string",
    "reviewedAt": "2019-08-24T14:15:22Z",
    "decisionNotes": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "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"
  }
}