Skip to content

ReadBondRequest

POST
/bond_request/{requestID}/read
curl --request POST \
--url https://api.huddlesurety.co/bond_request/example/read \
--header 'Content-Type: application/json' \
--data '{ "readerID": "example" }'
requestID
required
string

Request ID

Body

Media typeapplication/json

Body

object
readerID
required
string
Examplegenerated
{
"readerID": "example"
}

OK

Media typeapplication/json
object
bondType
required
string
Allowed values: bid final
completedAt
required
string
createdAt
required
string
id
required
string
orgID
required
string
projectID
required
string
readBy
required
Array<string>
sentAt
required
string
status
required
string
Allowed values: draft sent completed
updatedAt
required
string
Example
{
"bondType": "bid",
"status": "draft"
}