shareBidProposalWithCustomer
Requires permission biddesk:proposal:release.
Sends a released proposal revision to the bid's customer: its quote moves from DRAFT to SENT (through the quote's status rules) and the revision appears in the customer's portal for each of their active portal contacts. Sending again changes nothing. Refused with PROPOSAL_NOT_RELEASED (a draft or replaced revision), PROPOSAL_NO_QUOTE, PROPOSAL_NO_CUSTOMER, PROPOSAL_NO_PORTAL_CONTACT or VERSION_CONFLICT; a quote refusal is returned as is. Requires Bid Desk and permission to release proposals.
Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.
Example:
- GraphQL
- cURL
mutation ShareBidProposalWithCustomer($expectedVersion: Int!, $revisionId: ID!) {
shareBidProposalWithCustomer(
expectedVersion: $expectedVersion
revisionId: $revisionId
) {
quoteStatus
recipientCount
revisionId
sharedAt
}
}
curl -X POST "https://<api-host>/graphql" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
--data @- <<'EOF'
{
"query": "mutation ShareBidProposalWithCustomer($expectedVersion: Int!, $revisionId: ID!) {\n shareBidProposalWithCustomer(\n expectedVersion: $expectedVersion\n revisionId: $revisionId\n ) {\n quoteStatus\n recipientCount\n revisionId\n sharedAt\n }\n}",
"variables": {
"expectedVersion": 0,
"revisionId": "id"
}
}
EOF
Variables:
{
"expectedVersion": 0,
"revisionId": "id"
}
Response:
{
"data": {
"shareBidProposalWithCustomer": {
"quoteStatus": "string",
"recipientCount": 0,
"revisionId": "id",
"sharedAt": "2025-01-15T00:00:00Z"
}
}
}
shareBidProposalWithCustomer(
expectedVersion: Int!
revisionId: ID!
): BidProposalShareResult!
Arguments
shareBidProposalWithCustomer.expectedVersion ● Int! non-null scalar
The revision's version as last loaded.
shareBidProposalWithCustomer.revisionId ● ID! non-null scalar
The released revision to send.
Type
BidProposalShareResult object
What sending a released proposal revision to the customer did: when it was shared, its quote's status, and how many portal contacts can now see it.