Create Funding Application
POST https://api.suger.cloud/org/{orgId}/fundingApplication
Create an AWS funding application and send it to AWS Partner Central in the same call, or resubmit an existing one. This is the one-step path, for callers whose approval happens before the call; to stage a request for a person to review first, use CreateFundingApplicationDraft and then SubmitFundingApplication. The body is a funding application with `partner` AWS, the AWS benefit application in `info.awsBenefitApplication` (check it with ValidateFundingApplicationPayload first) and the CRM link in `salesforceOpportunityId` or `hubspotDealId`. Without an `id` it creates a new application. With the `id` of an existing one it resubmits it: use this when AWS asked for changes (status ACTION_REQUIRED) or the submission did not complete (status CREATE_FAILED with AWS status PENDING_SUBMISSION), sending the whole application back with the fields corrected. The response is the started submission, whose outcome later shows in the application's status (PENDING_ACCEPTANCE once AWS has it, CREATE_FAILED with errorMessages if AWS refused it). When the organization has the Salesforce funding approval process on, a new application whose `approvalInfo.approvalStatus` is not Approved is held as DRAFT for an approver, and Declined always holds it as DRAFT; the response is then null. Content that fails validation answers 400 with the reasons in `message`, and each field to fix, with its reason, in `info` (a list of `{field, message}`).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
Request Body
Required. Content-Type: application/json · Schema: FundingApplication
FundingApplication fields:
| Field | Type | Required | Description |
|---|---|---|---|
approvalInfo | ApprovalInfo | no | |
creationTime | string | no | CreationTime holds the value of the "creation_time" field. |
errorMessages | array<string> | no | ErrorMessages holds the value of the "error_messages" field. |
externalId | string | no | ExternalID holds the value of the "external_id" field. |
hubspotDealId | string | no | HubspotDealID holds the value of the "hubspot_deal_id" field. |
id | string | no | ID of the ent. |
info | FundingApplicationInfo | no | |
lastUpdateTime | string | no | LastUpdateTime holds the value of the "last_update_time" field. |
organizationId | string | no | OrganizationID holds the value of the "organization_id" field. |
partner | FundingapplicationPartner | no | |
salesforceFundingId | string | no | SalesforceFundingID holds the value of the "salesforce_funding_id" field. |
salesforceOpportunityId | string | no | SalesforceOpportunityID holds the value of the "salesforce_opportunity_id" field. |
status | string | no | Status holds the value of the "status" field. |
ApprovalInfo fields:
| Field | Type | Required | Description |
|---|---|---|---|
approvalStatus | ApprovalStatus | no | |
decisionDate | string | no | DecisionDate is when the final approval/decline happened (nil when pending) Latest DecisionDate |
message | string | no | Message is the reason or explanation provided when the approval status is set to Declined or Action Required. It always stores the latest message for the current status transition. Historical messages are stored in notification events. |
requestDate | string | no | Latest RequestDate |
FundingApplicationInfo fields:
| Field | Type | Required | Description |
|---|---|---|---|
awsBenefitAllocation | BenefitAllocation | no | |
awsBenefitAllocations | array<BenefitAllocation> | no | AWSBenefitAllocations is every allocation AWS gave the application, primary first; awsBenefitAllocation holds the primary (see MergeAWSBenefitAllocation) for readers that expect one. AWS can give one application several: a legacy MDF combo request has a cash and a credit pool, and AWS re-creates some credit allocations. Rows synced before this field existed leave it empty. |
awsBenefitApplication | BenefitApplication | no | |
cosellAgent | FundingApplicationCosellAgentInfo | no |
BenefitAllocation fields:
| Field | Type | Required | Description |
|---|---|---|---|
ApplicableBenefitIds | array<string> | no | The IDs of other benefits that this particular benefit allocation is applicable for. |
Arn | string | no | |
BenefitApplicationId | string | no | |
BenefitId | string | no | |
Catalog | string | no | |
CreatedAt | string | no | |
Description | string | no | |
ExpiresAt | string | no | |
FulfillmentDetail | BenefitAllocationFulfillmentDetail | no | |
FulfillmentTypes | array<FulfillmentType> | no | |
Id | string | no | |
Name | string | no | |
StartsAt | string | no | |
Status | BenefitAllocationStatus | no | |
StatusReason | string | no | |
UpdatedAt | string | no |
BenefitApplication fields:
| Field | Type | Required | Description |
|---|---|---|---|
Arn | string | no | |
AssociatedResources | array<string> | no | |
Attributes | object | no | |
BenefitApplicationDetails | object | no | |
BenefitId | string | no | |
Catalog | string | no | |
CreatedAt | string | no | |
Description | string | no | |
FileDetails | array<FileDetail> | no | |
FulfillmentTypes | array<FulfillmentType> | no | |
Id | string | no | |
Name | string | no | |
PartnerContacts | array<AceContact> | no | |
Programs | array<string> | no | |
Revision | string | no | |
Stage | string | no | |
Status | BenefitApplicationStatus | no | |
StatusReason | string | no | |
StatusReasonCodes | array<string> | no | |
UpdatedAt | string | no |
FundingApplicationCosellAgentInfo fields:
| Field | Type | Required | Description |
|---|---|---|---|
approvedBy | string | no | ApprovedBy is the person who approved it; in AUTO, the person the run acted for. |
mode | CosellAgentMode | no | |
referralId | string | no | ReferralID is the co-sell referral the application was filed for. |
runId | string | no | RunID is the agent run that proposed it ("chat" for one made in the co-sell chat). |
skillId | string | no | SkillID is the agent skill that proposed it. |
FileDetail fields:
| Field | Type | Required | Description |
|---|---|---|---|
BusinessUseCase | string | no | Project Plan/Checklist", "Innovation Plan", "Marketing Plan", " Proof of Cost", "Assess Analysis Report", "Well Architected Review Report", "Success Criteria Report", "Customer Sign Off Template", "Partner Sign Off Template", "Customer Satisfaction Survey (CSAT)", "Migration Capability Review", "Other" |
CreatedAt | string | no | |
FileName | string | no | ^[a-zA-Z0-9._-]+$ |
FileStatus | string | no | PENDING, SUCCEDED, FAILED |
FileType | string | no | Valid mime type:application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/pdf, image/png, image/jpeg, image/svg+xml, text/csv |
FileURI | string | no | |
UpdatedAt | string | no |
AceContact fields:
| Field | Type | Required | Description |
|---|---|---|---|
BusinessTitle | string | no | |
Email | string | no | |
FirstName | string | no | |
LastName | string | no | |
Phone | string | no |
Responses
200 — Success
Content-Type: application/json · Schema: OperationExecutionDetails
OperationExecutionDetails fields:
| Field | Type | Required | Description |
|---|---|---|---|
newWorkflowStarted | boolean | no | |
referralId | string | no | ReferralID is the created referral's id, set by the SUGER co-sell create so the caller can chain follow-up calls (e.g. InviteCosellPartners) onto the new engagement without re-querying. Empty elsewhere. |
runID | string | no | |
slackMirrorWarning | string | no | SlackMirrorWarning is a non-blocking advisory set when a SUGER co-sell console message was saved but could not be mirrored to the partner's Slack channel (no workspace connected, no channel mapped, bot not in the channel, or a transient post failure). Empty when the message mirrored or Slack is not involved. The console surfaces it as a warning toast; the message is always persisted regardless (best-effort mirror). |
status | string | no | |
workflowID | string | no |
400 — Bad request error
Content-Type: application/json · Schema: ErrorResponse
ErrorResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
code | ErrorCode | no | |
info | object | no | |
message | string | no |
500 — Internal server error
Content-Type: application/json · Schema: ErrorResponse
ErrorResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
code | ErrorCode | no | |
info | object | no | |
message | string | no |
Example
The request bodies are this operation's documented examples; the
response and error bodies are generated from its schema. Substitute your
own ids, and set SUGER_TOKEN to a bearer token from the
OAuth client-credentials exchange.
Request
File an MPOPP Activate credit request with AWS Partner Central in one call
Creates the application and starts the submission at once; use it when the request is already approved. `BenefitId` names the program (MPOPP Activate on the AWS catalog).
curl -X POST 'https://api.suger.cloud/org/{orgId}/fundingApplication' \
-H "Authorization: Bearer $SUGER_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"partner": "AWS",
"salesforceOpportunityId": "006Hs00001AbCdEIAV",
"info": {
"awsBenefitApplication": {
"Name": "Contoso Freight - MPOPP Activate",
"BenefitId": "ben-fz5vn6p789ma76",
"Catalog": "AWS",
"AssociatedResources": [
"arn:aws:partnercentral:us-east-1:aws:catalog/AWS/opportunity/O1234567"
],
"PartnerContacts": [
{
"Email": "alliances@example.com",
"FirstName": "Jordan",
"LastName": "Lee",
"BusinessTitle": "Alliance Manager"
}
],
"BenefitApplicationDetails": {
"AwsAccountId": "123456789012",
"OfferId": "offer-bpgicw3556ywx",
"PlannedStartDate": "2026-11-01T00:00:00Z",
"PlannedEndDate": "2026-12-31T00:00:00Z",
"BusinessDescription": "Contoso Freight accepted a 12-month private offer for dispatch analytics on AWS.",
"AnnualRunRate": {
"Amount": "120000",
"Currency": "USD"
},
"CreditRequest": {
"NumberOfCodes": 1,
"ValuePerCode": {
"Amount": "5000",
"Currency": "USD"
}
}
}
}
}
}' Resubmit an application AWS sent back for changes
The `id` of an application in status ACTION_REQUIRED, sent back whole with the fields AWS asked about corrected. `info.Id` stays the AWS benefit application id it already has.
curl -X POST 'https://api.suger.cloud/org/{orgId}/fundingApplication' \
-H "Authorization: Bearer $SUGER_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"partner": "AWS",
"salesforceOpportunityId": "006Hs00001AbCdEIAV",
"info": {
"awsBenefitApplication": {
"Name": "Contoso Freight - MPOPP Activate",
"BenefitId": "ben-fz5vn6p789ma76",
"Catalog": "AWS",
"AssociatedResources": [
"arn:aws:partnercentral:us-east-1:aws:catalog/AWS/opportunity/O1234567"
],
"PartnerContacts": [
{
"Email": "alliances@example.com",
"FirstName": "Jordan",
"LastName": "Lee",
"BusinessTitle": "Alliance Manager"
}
],
"BenefitApplicationDetails": {
"AwsAccountId": "123456789012",
"OfferId": "offer-bpgicw3556ywx",
"PlannedStartDate": "2026-11-01T00:00:00Z",
"PlannedEndDate": "2026-12-31T00:00:00Z",
"BusinessDescription": "Contoso Freight accepted a 12-month private offer for dispatch analytics on AWS; the offer covers 40 depots across the US.",
"AnnualRunRate": {
"Amount": "120000",
"Currency": "USD"
},
"CreditRequest": {
"NumberOfCodes": 1,
"ValuePerCode": {
"Amount": "5000",
"Currency": "USD"
}
}
},
"Id": "benappl-vl3ki4gxsqrpx3"
}
},
"id": "3f9c2a1e-7b4d-4c8e-9a51-2d6f0b8e4c17"
}' Response — 200
{
"newWorkflowStarted": true,
"referralId": "01H0000000000000000000",
"runID": "01H0000000000000000000",
"slackMirrorWarning": "string",
"status": "string",
"workflowID": "01H0000000000000000000"
} Error — 400
{
"code": "InternalServerError",
"message": "string"
} View as Markdown · API reference overview
Spotted something wrong or out of date on this page? Tell us and we'll correct it.