Upsert vouch

PUT

https://api.sureshake.com/v2/entities/{entityId}/vouches

Path parameters

entityId
string
required
format: uuid

Request body JSON required

voucherEntityId
string
required
format: uuid
scope
optional
string
maxLength: 64 · minLength: 1 · default: "general"
confidence
optional
integer
maximum: 5 · minimum: 1 · default: 3
evidenceHash
optional
string
maxLength: 255 · minLength: 1
evidenceCid
optional
string
maxLength: 255 · minLength: 1
comment
optional
string
maxLength: 500
expiresAt
optional
string
or null
format: date-time

Returns

200

Default Response

JSON

data
object
required
- vouchId
  string
  required
  format: uuid
- recalculatedOverall
  number
  or null
  required
- recalculatedGrade
  AAA
  or
  AA
  or
  A
  or
  BBB
  or
  BB
  or
  B
  +4 more
  or null
  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
}

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
}

501

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
}

curl --request PUT \ --url 'https://api.sureshake.com/v2/entities/<entityId>/vouches' \ --header 'Content-Type: application/json' \ --data ' { "voucherEntityId": "687a822d-209a-4607-9d86-54cce0292c95", "scope": "general", "confidence": 3, "evidenceHash": "string", "evidenceCid": "string", "comment": "string", "expiresAt": "2019-08-24T14:15:22Z" } '