Skip to main content
POST
/
api
/
broker_funder_policies
/
funders
Add a funder to broker's policies
curl --request POST \
  --url https://app.herondata.io/api/broker_funder_policies/funders/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "funder_heron_id": "<string>"
}
'
{
  "broker_user_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "external_reference_id": 123,
  "funder_heron_id": "<string>",
  "last_updated": "2023-11-07T05:31:56Z",
  "offer_calculation_constants_override": {},
  "offer_email_instructions_override": "<string>",
  "offer_portal_instructions_override": "<string>",
  "offer_source_override": "email",
  "staging_submission_integration_id": 123,
  "submission_cc_email_addresses": [
    "<string>"
  ],
  "submission_channel_override": "email",
  "submission_email_address": "<string>",
  "submission_integration_id": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.herondata.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Body

application/json
funder_heron_id
string
required

Heron ID of the funder to add

Response

Funder already exists in policies (no modification)

broker_user_id
integer
read-only
created
string<date-time>
read-only
external_reference_id
integer | null
read-only
funder_heron_id
string
read-only
last_updated
string<date-time>
read-only
offer_calculation_constants_override
object
read-only
offer_email_instructions_override
string | null
read-only
offer_portal_instructions_override
string | null
read-only
offer_source_override
any | null
read-only
Available options:
email,
api,
web_portal,
all_offers,
crm_lendsaas,
null
staging_submission_integration_id
integer | null
read-only
submission_cc_email_addresses
string[] | null
read-only
submission_channel_override
any | null
read-only
Available options:
email,
api,
web_portal,
all_offers,
crm_lendsaas,
null
submission_email_address
string | null
read-only
submission_integration_id
integer | null
read-only