Examples

PATCH /api/v2/insight-disclosures/13
{
  "data": {
    "id": "13",
    "type": "insight-disclosures",
    "attributes": {
      "position-in-securities": "no-position",
      "certified": true
    },
    "relationships": {
      "insight": {
        "data": {
          "type": "insights",
          "id": "12"
        }
      }
    }
  }
}
200
{
  "data": {
    "id": "13",
    "type": "insight-disclosures",
    "links": {
      "self": "http://test.host/api/v2/insight-disclosures/13"
    },
    "attributes": {
      "position-in-securities": "no-position",
      "certified": true
    },
    "relationships": {
      "insight": {
        "links": {
          "self": "http://test.host/api/v2/insight-disclosures/13/relationships/insight",
          "related": "http://test.host/api/v2/insight-disclosures/13/insight"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Insight disclosure ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

insight disclosure information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][position-in-securities]
optional

Validations:

  • Must be a String

data[attributes][certified]
optional

Validations:

  • Must be one of: true, false.