Update campaign run

Request

Update campaign run data.

Security

oauth2(Required scopes: borrowercampaign.run:update) or bearerAuth or apiKeyHeader

Path

borrowerCampaignIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-onlyrequired

Peach's unique or lender's external identifier.

borrowerCampaignRunIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-onlyrequired

Peach's unique or lender's external identifier.

Bodyapplication/json

availableFilesArray of strings

The list of files currently available for download via this campaign run's .../download endpoint.

Items Enum:"query_results.csv""campaign_input.json""contacts.csv""log.txt"

borrowerCampaignIdstring

The ID of the borrower campaign to which this campaign run belongs.

campaignInputFileIdstringwrite-only

contactsOutputFileIdstringwrite-only

logFileIdstringwrite-only

queryResultsFileIdstringwrite-only

statusstring(BorrowerCampaignRunStatus)

The status of a campaign run

Enum:"failed""success""processing""initializing"

PUT

/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}

curl -i -X PUT \
  'https://sandboxapi.peach.finance/api/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "availableFiles": [
      "query_results.csv"
    ],
    "borrowerCampaignId": "string",
    "campaignInputFileId": "string",
    "contactsOutputFileId": "string",
    "logFileId": "string",
    "queryResultsFileId": "string",
    "status": "failed"
  }'

Responses

Success