post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/updateOffering
This method is used to update an offering in Transact API. The Offering ID is required as a request parameter for the update to take place.
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| clientID | yes | string | TransactAPI Client ID |
| developerAPIKey | yes | string | TransactAPI Developer Key |
| offeringId | yes | integer | Offering ID that is generated by the API when an Offering is created (createOffering) |
| issueName | yes | string | Name of the Offering |
| issueType | yes | conditional | Type of Offering: Equity, Debt, Hybrid, Fund |
| targetAmount | yes | decimal | The Target Amount of the Raise (should be LESS than Maximum Amount) |
| minAmount | yes | decimal | The Minimum amount that can be invested at one time |
| maxAmount | yes | decimal | The Maximum amount of the offering (cap amount) |
| unitPrice | yes | decimal | Price per Unit (unit/share price). The investment can only be made in increments of this number |
| startDate | yes | string | Offering Start Date |
| endDate | yes | string | Offering End Date |
| offeringStatus | yes | string | Optional Approval Status of the offering. Statuses are Pending, Approved, Denied |
| offeringText | yes | string | A brief description of the offering |
| providerId | no | integer | Custodian / Escrow ID of the institution that is holding the escrow account for the offering |
| stampingText | no | string | The text that is watermarked on the offering documents(addDocumentsforOffering). (Example: "Confidential") |
| updatedIPAddress | no | integer | Updated IP Address |
| escrowAccountNumber | no | string | Escrow Account Number |
| field1 | no | string | Additional information relating to the offering. Custom Field 1 |
| field2 | no | string | Additional information relating to the offering. Custom Field 2 |
| field3 | no | string | Additional information relating to the offering. Custom Field 3 |
Sample Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/updateOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=65432
-d issueName=John Smith
-d issueType=debt
-d targetAmount=8100.00
-d minAmount=101.00
-d maxAmount=10050.00
-d unitPrice=25.75
-d startDate=03-23-2016
-d endDate=03-23-2016
-d offeringStatus=approved
-d offeringText=Offering Text
-d stampingText=Sample Text
-d escrowAccountNumber=Sample Text
-d field1=Sample Text
-d field2=Sample Text
-d field3=Sample Text
-d updatedIPaddress=10.0.0.110
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| statusCode | string | API Status Code |
| statusDesc | string | API Status Description |
| offeringId | integer | Generated Offering ID |
| providerId | integer | Custodian / Escrow ID of the institution that is holding the escrow account for the offering |
| offeringStatus | string | Status of offering like Pending | Approved | Denied |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"offeringDetails": [
true,
[
{
"offeringId": "65432",
"offeringStatus": "Approved"
}
]
]
}