Updates a project.

Request

Security

ApiKey

Path

institutionIdstring, (uuid)required

The ID of the institution.

Body

The project data transfer object.

idstring, (uuid), non-emptyrequired

namestring, [ 1 .. 100 ] charactersrequired

institutionIdstring, (uuid)

startOfSubscriptionstring or null

Optional for Share Token Projects (YYYY-MM-DD). If not provided the existing value won't change.

endOfSubscriptionstring or null

Optional for Share Token Projects (YYYY-MM-DD). If not provided the existing value won't change.

targetIssuanceDatestring or null

Optional for Share Token Projects (YYYY-MM-DD). If not provided the existing value won't change.

dueDateOfPaymentsstring or null

Optional (YYYY-MM-DD)

terminationRightsstring or null

Allowed values: 'yes' / 'no'. If not provided the existing value won't change.

issueSizestring or null

A number in string format.

entryTypestring or null

If not provided the existing value won't change.

Enum:"Collective""Individual"

statusstring or null

If not provided the existing value won't change.

Enum:"Initiated""Live""InProgress""Active""Finished""Terminated""ActionNeeded"

blockchainstring or null

If not provided the existing value won't change. Allowed values: 'Polygon', 'Stellar' OR 3 (Stellar), 14 (Polygon).

Enum:"Polygon""Stellar"

currentPassphrasestring or null

projectPassphrasestring or null

curl -i -X PUT \
  'https://vault.nyala.de/api/Project/{institutionId}' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "institutionId": "cdae5c01-a629-4362-be56-52101ec22a49",
    "startOfSubscription": "string",
    "endOfSubscription": "string",
    "targetIssuanceDate": "string",
    "dueDateOfPayments": "string",
    "terminationRights": "string",
    "issueSize": "string",
    "entryType": "Collective",
    "status": "Initiated",
    "blockchain": "Polygon",
    "currentPassphrase": "string",
    "projectPassphrase": "string"
  }'

Responses

OK

Bodyapplication/json

databoolean

errorMessageCodesArray of any or null

Example:null

Response

{
  "data": true,
  "errorMessageCodes": null
}