Share one immutable draft preview with a named recipient

POST

https://api.sureshake.com/v2/entities/{id}/presentation/preview-grants

Path parameters

id
string
required
format: uuid

Request body JSON required

versionId
string
required
format: uuid
recipientIdentifier
string
required
maxLength: 320 · minLength: 1
expiresAt
string
required
format: date-time
operatorOverride
optional
object
- confirmed
  true
  required
- reason
  string
  required
  maxLength: 500 · minLength: 10
}

Returns

201

Default Response

JSON

data
object
required
- grant
  object
  required
  id
  string
  required
  format: uuid
  presentationId
  string
  required
  format: uuid
  entityId
  string
  required
  format: uuid
  versionId
  string
  required
  format: uuid
  recipientUserId
  string
  required
  minLength: 1
  grantedByUserId
  string
  required
  minLength: 1
  expiresAt
  string
  required
  format: date-time
  revokedAt
  string
  or null
  required
  format: date-time
  revokedByUserId
  string
  or null
  required
  minLength: 1
  createdAt
  string
  required
  format: date-time
- recipient
  object
  required
  id
  string
  required
  minLength: 1
  name
  string
  required
  minLength: 1
  email
  string
  required
  format: email
- status
  active
  or
  expired
  or
  revoked
  required
- sharePath
  string
  required
  pattern: ^\/
}
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
}

curl --request POST \ --url 'https://api.sureshake.com/v2/entities/<id>/presentation/preview-grants' \ --header 'Content-Type: application/json' \ --data ' { "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "recipientIdentifier": "string", "expiresAt": "2019-08-24T14:15:22Z", "operatorOverride": { "confirmed": true, "reason": "stringstri" } } '

{ "data": { "grant": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "presentationId": "e1fc6bcc-f902-4bce-8b40-504b99e58d26", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "recipientUserId": "string", "grantedByUserId": "string", "expiresAt": "2019-08-24T14:15:22Z", "revokedAt": "2019-08-24T14:15:22Z", "revokedByUserId": "string", "createdAt": "2019-08-24T14:15:22Z" }, "recipient": { "id": "string", "name": "string", "email": "user@example.com" }, "status": "active", "sharePath": "string" }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }