Examples

PATCH /api/v2/watchlists/48/remove_entities
{
  "data": {
    "id": "48",
    "type": "watchlists",
    "attributes": {
      "name": "My Portfolio"
    },
    "relationships": {
      "entities": {
        "data": [
          {
            "type": "entities",
            "id": "26"
          }
        ]
      }
    }
  }
}
200
{
  "data": {
    "id": "48",
    "type": "watchlists",
    "links": {
      "self": "/api/v2/watchlists/48"
    },
    "attributes": {
      "name": "My Portfolio"
    },
    "relationships": {
      "account": {
        "links": {
          "self": "/api/v2/watchlists/48/relationships/account",
          "related": "/api/v2/watchlists/48/account"
        }
      },
      "entities": {
        "links": {
          "self": "/api/v2/watchlists/48/relationships/entities",
          "related": "/api/v2/watchlists/48/entities"
        }
      }
    }
  }
}

Params

Param name Description
id
required

watchlist 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

watchlist information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][account]
optional

Validations:

  • Must be a Hash

data[relationships][account][data]
optional

Validations:

  • Must be a Hash

data[relationships][account][data][type]
optional

Account type, which is `accounts`

Validations:

  • Must be a String

data[relationships][account][data][id]
optional

Account 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[relationships][watchable]
optional

Validations:

  • Must be a Hash

data[relationships][watchable][data]
optional

Validations:

  • Must be a Hash

data[relationships][watchable][data][type]
optional

Watchable type, which can either be `entities`, `insights`, or `accounts`

Validations:

  • Must be a String

data[relationships][watchable][data][id]
optional

Watchable 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.