Update composition

PUT

https://api.sureshake.com/v2/directory/{subjectType}/{slug}/composition

Path parameters

subjectType
person
or
entity
required

slug
string
required
maxLength: 255 · minLength: 1

Request body JSON

blocks
optional
array of
object
- blockType
  header
  or
  trust
  or
  about
  or
  team
  or
  metrics
  or
  capital_graph
  +16 more
  required
- order
  integer
  required
- visibility
  optional
  public
  or
  follower
  or
  capital
  or
  diligence
  or
  custom
  default: "public"
- config
  optional
  map of
  unknown
}
layout
optional
standard
or
raising
or
minimal
or
public_company
or
private_company
publish
optional
boolean
default: false

Returns

200

Default Response

JSON

data
object
required
- listingId
  string
  required
  format: uuid
- composition
  array of
  object
  required
  blockType
  header
  or
  trust
  or
  about
  or
  team
  or
  metrics
  or
  capital_graph
  +16 more
  required
  order
  integer
  required
  visibility
  optional
  public
  or
  follower
  or
  capital
  or
  diligence
  or
  custom
  default: "public"
  config
  optional
  map of
  unknown
- published
  boolean
  required
- publishedVersion
  integer
  or null
  required
}
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 composition

curl --request PUT \
  --url 'https://api.sureshake.com/v2/directory/person/<slug>/composition' \
  --header 'Content-Type: application/json' \
  --data '
{
  "blocks": [
    {
      "blockType": "header",
      "visibility": "public",
      "order": 0,
      "config": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "layout": "standard",
  "publish": false
}
'

const url = 'https://api.sureshake.com/v2/directory/person/<slug>/composition';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    blocks: [
      {
        blockType: 'header',
        visibility: 'public',
        order: 0,
        config: {property1: null, property2: null}
      }
    ],
    layout: 'standard',
    publish: false
  })
};

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/<slug>/composition"

payload = {
    "blocks": [
        {
            "blockType": "header",
            "visibility": "public",
            "order": 0,
            "config": {
                "property1": None,
                "property2": None
            }
        }
    ],
    "layout": "standard",
    "publish": False
}
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",
    "composition": [
      {
        "blockType": "header",
        "visibility": "public",
        "order": 0,
        "config": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "published": true,
    "publishedVersion": 0
  },
  "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"
  }
}