Create commitment attestation invitation

POST

https://api.sureshake.com/v2/execution/cycles/{cycleId}/commitments/{commitmentId}/attestation-invitations

Path parameters

cycleId
string
required
format: uuid

commitmentId
string
required
format: uuid

Request body JSON required

expectedVersionNumber
integer
required
minimum: 1
invitedEmail
string
required
format: email · maxLength: 320
relationship
customer
or
mentor
or
advisor
or
program_operator
or
capital_provider
required
expiresAt
optional
string
format: date-time

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- cycleId
  string
  required
  format: uuid
- commitmentId
  string
  required
  format: uuid
- commitmentVersionNumber
  integer
  required
  minimum: 1
- resolutionId
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- inviteeUserId
  string
  required
  minLength: 1
- invitedEmail
  string
  required
  format: email
- relationship
  customer
  or
  mentor
  or
  advisor
  or
  program_operator
  or
  capital_provider
  required
- status
  pending
  or
  used
  or
  revoked
  or
  expired
  required
- invitedByUserId
  string
  required
  minLength: 1
- expiresAt
  string
  required
  format: date-time
- usedByUserId
  string
  or null
  required
  minLength: 1
- usedAt
  string
  or null
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
- delivery
  in_app
  required
}
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
}