CorefinityCorefinityDocs
Open the Control PanelControl Panel
Agency · 6 of 7

Create a partner referral

Records a lead as your own agency's referral and emails Corefinity's sales team about it. Your role needs the createAgencyLeads permission.

POST/api/agency/referrals

Body

company_namestringRequired

Up to 255 characters.

contact_leadboolean

Whether Corefinity may contact the lead directly. false when left out.

current_costnumber or null

0 to 99999999.

current_providerstring or null

Up to 255 characters.

main_contact_emailstring or null

An address whose domain can receive email; the domain is looked up, so the placeholder address in the example is refused 422 on this field. Up to 255 characters.

main_contact_mobilestring or null

A mobile number. It is checked against main_contact_mobile_country and saved in international form. Up to 32 characters.

main_contact_mobile_countrystring or null

The two-letter country code of the mobile number, such as GB. A UK number needs none. Up to 2 characters.

main_contact_namestring or null

Up to 255 characters.

notesstring or null

Up to 65,535 characters.

preferred_contact_methodstring or null
emailphonenull
website_urlstringRequired

A host name, with or without http:// or https://, and with a path if you like. Up to 255 characters.

Returns

201 The referral was recorded.

Fields of the 201 answer
dataobjectRequired

A lead your agency referred to Corefinity.

Fields
company_namestringRequired
contact_leadbooleanRequired

Whether Corefinity may contact the lead directly.

created_atstring or nullRequired

Format: date-time.

current_costnumber or nullRequired

What the lead pays for hosting today.

current_providerstring or nullRequired

Who hosts the lead today.

idintegerRequired

At least 1.

main_contact_emailstring or nullRequired
main_contact_mobilestring or nullRequired

The mobile number in international form, such as +447700900123.

main_contact_mobile_countrystring or nullRequired

The two-letter country code the number was read with.

main_contact_namestring or nullRequired
notesstring or nullRequired

Your notes. When Corefinity may contact the lead and the contact's mobile or email is missing, a line saying so is added.

preferred_contact_methodstring or nullRequired
emailphonenull
website_urlstringRequired

The lead's website, as it was typed. The scheme is optional.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403forbiddenThe person is not allowed to do this.
403scope_requiredUse a token with the scope named in scope.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl -X POST https://manage.corefinity.com/api/agency/referrals \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Harbour & Finch",
    "contact_lead": true,
    "current_cost": 120.5,
    "current_provider": "Another host",
    "main_contact_email": "[email protected]",
    "main_contact_mobile": "07700 900123",
    "main_contact_mobile_country": "GB",
    "main_contact_name": "Eleanor Finch",
    "notes": "Moving this quarter.",
    "preferred_contact_method": "phone",
    "website_url": "https://harbourandfinch.example.com"
  }'
{
  "data": {
    "company_name": "Harbour & Finch",
    "contact_lead": true,
    "created_at": "2026-11-09T10:15:00Z",
    "current_cost": 120.5,
    "current_provider": "Another host",
    "id": 3120,
    "main_contact_email": "[email protected]",
    "main_contact_mobile": "+447700900123",
    "main_contact_mobile_country": "GB",
    "main_contact_name": "Eleanor Finch",
    "notes": "Moving this quarter.",
    "preferred_contact_method": "phone",
    "website_url": "https://harbourandfinch.example.com"
  }
}
Try it

Try it is off for this endpointIt sends email to real people. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT