How do I create a corporate action source?

You can create a corporate action source (CAS) in which to subsequently load corporate actions.

Note you must subscribe one or more portfolios to the CAS in order for loaded corporate actions to take effect.

Methods

curl -X POST 'https://<your-domain>.lusid.com/api/api/corporateactionsources'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "scope": "Example-CAS-scope",
  "code": "Example-CAS-code",
  "displayName": "Example corporate action source",
  "description": "This is an example corporate action source",
  "instrumentScopes": ["example-instrument-scope"]
}'

Data fields

This section supplements the API documentation and on-screen help text in the LUSID web app.

A corporate action source is identified by a scope and a code that must be unique within that scope.

You must specify a displayName and can specify a description.

Specify a single instrument scope in the instrumentScopes field if all portfolios you intend to register resolve economic activity to instruments mastered in that scope. If all intended portfolios resolve to instruments mastered in the default scope, you can omit this field.

Subsequent updates

It is not possible to update a corporate action source. You must delete it and start over.