Create goal

POST

https://api.sureshake.com/v2/execution/goals

Request body JSON required

entityId
string
required
format: uuid

title
string
required
category
revenue
or
product
or
hiring
or
customers
or
partnerships
or
custom
required
goalType
financial_auto
or
manual
required
cycleId
optional
string
format: uuid
description
optional
string
weight
optional
number
targetValue
optional
number
deadlineAt
optional
string
format: date-time

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- title
  string
  required
- outcome
  string
  required
- ownerUserId
  string
  or null
  required
  minLength: 1
- completionDefinition
  string
  or null
  required
  maxLength: 2000 · minLength: 1
- proofStandard
  string
  or null
  required
  maxLength: 2000 · minLength: 1
- category
  revenue
  or
  product
  or
  hiring
  or
  customers
  or
  partnerships
  or
  custom
  required
- goalType
  financial_auto
  or
  manual
  required
- commitmentTargetValue
  number
  or null
  required
- baselineValue
  number
  or null
  required
- measurementUnit
  string
  or null
  required
  maxLength: 100 · minLength: 1
- expectedEffortMinutes
  integer
  or null
  required
  maximum: 10080 · minimum: 1
- dependencies
  array of
  string
  or null
  required
  maxLength: 500 · minLength: 1
- risks
  array of
  string
  or null
  required
  maxLength: 500 · minLength: 1
- qualityWarnings
  array of
  object
  or null
  required
  code
  activity_based
  or
  not_objectively_closeable
  required
  message
  string
  required
  maxLength: 500 · minLength: 1
  fields
  array of
  outcome
  or
  completionDefinition
  or
  proofStandard
  required
- qualityAssessedAt
  string
  or null
  required
  format: date-time
- status
  string
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- cycleId
  optional
  string
  or null
  format: uuid
- description
  optional
  string
  or null
- successCriteria
  optional
  string
  or null
- weight
  optional
  number
  or null
- targetValue
  optional
  number
  or null
- actualValue
  optional
  number
  or null
- completionPct
  optional
  number
  or null
- deadlineAt
  optional
  string
  or null
  format: date-time
- committedAt
  optional
  string
  or null
  format: date-time
- commitmentStartAt
  optional
  string
  or null
  format: date-time
- currentVersionNumber
  optional
  integer
  or null
  minimum: 1
- payloadHash
  optional
  string
  or null
}
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
}

422

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
}

429

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
}

502

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
}

503

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
}