Skip to main content
POST
/
api
/
funder_integrations
Link a funder to the current broker for self-service
curl --request POST \
  --url https://app.herondata.io/api/funder_integrations/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "funder_heron_id": "<string>"
}
'
{
  "funder_heron_id": "<string>",
  "funder_name": "<string>",
  "supports_staging": true,
  "config": {
    "display_name": "<string>",
    "form_fields": [
      {
        "label": "<string>",
        "name": "<string>",
        "required": true
      }
    ],
    "supports_staging": true
  },
  "funder_logo_url": "<string>",
  "production": {
    "has_credentials": true,
    "last_test_attempted_at": "2023-11-07T05:31:56Z",
    "last_test_deal_id": "<string>",
    "last_test_status_message": "<string>"
  },
  "slug": "<string>",
  "staging": {
    "has_credentials": true,
    "last_test_attempted_at": "2023-11-07T05:31:56Z",
    "last_test_deal_id": "<string>",
    "last_test_status_message": "<string>"
  }
}

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

Response

Funder linked

​
funder_heron_id
string
required
​
funder_name
string
required
​
state
enum<string>
required
Available options:
not_available,
not_configured,
staging_configured,
staging_tested,
live
​
supports_staging
boolean
required
​
channel_type
any | null
Available options:
api,
portal,
null
​
config
object
​
funder_logo_url
string | null
​
production
object
​
slug
string | null
​
staging
object