AM - Update Tender Offer

Details

/external/v1/tender-offers/{tenderOfferId}

Synopsis

Update Tender Offer

put

This route is used to trigger an update of a tender offer that is still in "draft" status.

It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints.

This endpoint can be invoked if the security is in one of the following statuses: ["active","completed","approved_revert_to_active","closed"].

This endpoint can be invoked if the tender offer is in one of the following statuses: ["draft"].

This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].

This endpoint can't be invoked if the security is restricted.

This endpoint can be called by applications with access to scope "manageTenderOffer".

Authorizations

Path parameters

tenderOfferIdanyRequired

The id that uniquely identifies the tender offer on the ledger.

Example: TEST6688

Body

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where the tender offer is being updated

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}

tenderOfferDataall ofRequired

This property contains the tender offer data

Example: {"startDate":"2024-09-12T00:00:00.000Z","cutOffDate":"2024-09-12T00:00:00.000Z","closeDate":"2024-09-12T00:00:00.000Z","settlementDate":"2024-09-12T00:00:00.000Z"}

Responses

200

Successfully triggered an update of the tender offer

application/json

400

The following error codes can be returned: - GN0002 - IS0008 - IS0106 - TO0002 - TO0016 - TO0044 - TO0017 - TO0045 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 - AU0003 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 - IS0099 Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned: - TO0001 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - IS0013 - IS0012 - IS0010 - IS0002 - IS0018 - TO0003 - TO0005 - TO0004 - TO0014 - TO0015 - TO0018 Please refer to the error code dictionary for the details of each error code.

application/json

put

HTTPcURLJavaScriptPython

PUT /external/v1/tender-offers/{tenderOfferId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "tenderOfferData": {
    "startDate": "2024-09-12T00:00:00.000Z",
    "cutOffDate": "2024-09-12T00:00:00.000Z",
    "closeDate": "2024-09-12T00:00:00.000Z",
    "settlementDate": "2024-09-12T00:00:00.000Z"
  }
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}

Important Notes

• See Blockchain Transaction Tracking for information on using orchestrationId and processId.