Create a permissioned equity Capital Objective

POST

https://api.sureshake.com/v2/startups/{startupListingId}/capital-objectives

Path parameters

startupListingId
string
required
format: uuid

Request body JSON required

targetAmount
number
required
minimum: 0
executionCycleId
optional
string
or null
format: uuid
instrument
optional
equity
default: "equity"
currency
optional
string
pattern: ^[A-Z]{3}$ · default: "USD"
minimumAmount
optional
number
or null
minimum: 0
maximumAmount
optional
number
or null
minimum: 0
status
optional
draft
or
active
default: "draft"

Returns

200

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- startupListingId
  string
  required
  format: uuid
- executionCycleId
  string
  or null
  required
  format: uuid
- instrument
  equity
  required
- currency
  string
  required
- targetAmount
  string
  required
- minimumAmount
  string
  or null
  required
- maximumAmount
  string
  or null
  required
- status
  draft
  or
  active
  or
  closed
  required
- createdByUserId
  string
  required
- createdAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Create a permissioned equity Capital Objective

curl --request POST \
  --url 'https://api.sureshake.com/v2/startups/<startupListingId>/capital-objectives' \
  --header 'Content-Type: application/json' \
  --data '
{
  "executionCycleId": "e7b7241f-56e0-4410-87c8-9797419cf32b",
  "instrument": "equity",
  "currency": "USD",
  "targetAmount": 0,
  "minimumAmount": 0,
  "maximumAmount": 0,
  "status": "draft"
}
'

const url = 'https://api.sureshake.com/v2/startups/<startupListingId>/capital-objectives';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    executionCycleId: 'e7b7241f-56e0-4410-87c8-9797419cf32b',
    instrument: 'equity',
    currency: 'USD',
    targetAmount: 0,
    minimumAmount: 0,
    maximumAmount: 0,
    status: 'draft'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.sureshake.com/v2/startups/<startupListingId>/capital-objectives"

payload = {
    "executionCycleId": "e7b7241f-56e0-4410-87c8-9797419cf32b",
    "instrument": "equity",
    "currency": "USD",
    "targetAmount": 0,
    "minimumAmount": 0,
    "maximumAmount": 0,
    "status": "draft"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "startupListingId": "d16a646b-f433-44ce-aaae-42761cf79f25",
    "executionCycleId": "e7b7241f-56e0-4410-87c8-9797419cf32b",
    "instrument": "equity",
    "currency": "string",
    "targetAmount": "string",
    "minimumAmount": "string",
    "maximumAmount": "string",
    "status": "draft",
    "createdByUserId": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}