FOfountain
referralCampaigns

Process a referral campaign request

post/api/servicereferral/processes/referralCampaigns

Request

  • Base URL
    https://services.fountain.com
  • URL
    https://services.fountain.com/api/servicereferral/processes/referralCampaigns
  • Auth
    none required

Request body

utm_sourcestring
utm_contentstring uuid required

The ReferralApplication uuid the referred applicant applied under. Used solely as the internal lookup key for the referral application; must be a uuid.

utm_termstring
utm_mediumstring
utm_campaignstring
status'self_identified' | 'applied' | 'hired' | 'rejected' | 'stage_changed' required
applicantSourcestring

Example request

{
  "applicant": {
    "email": "example@applicant.com",
    "name": "John Smith",
    "first_name": "John",
    "last_name": "Smith",
    "phone_number": "214-609-0494",
    "normalized_phone_number": "+12146090494",
    "phone_number_country_code": "+1",
    "created_at": "2024-01-10T05:19:37.788-08:00",
    "id": "5c0f5463-0103-46ce-abd3-749f5551d00e",
    "background_checks": [
      {
        "status": "clear",
        "title": "Example Background Check Title",
        "updated_at": "2024-01-10T05:19:37.788-08:00",
        "candidate_id": "19ee9327-4f66-43d8-96cb-57ae3f6afba4",
        "report_id": "19ee9327-4f66-43d8-96cb-57ae3f6afba4",
        "vendor": "checkr"
      }
    ],
    "work_availability": "sunday_morning",
    "date_of_birth": "29-11-1989",
    "funnel": {
      "title": "Example Funnel Title",
      "id": "19ee9327-4f66-43d8-96cb-57ae3f6afba4",
      "location": {
        "name": "Example Location Name",
        "id": "19ee9327-4f66-43d8-96cb-57ae3f6afba4",
        "latitude": 37.7749,
        "longitude": 122.4194,
        "location_group": {
          "name": "Example Location Name",
          "id": "19ee9327-4f66-43d8-96cb-57ae3f6afba4"
        }
      },
      "position": {
        "name": "Example Location Name",
        "id": "19ee9327-4f66-43d8-96cb-57ae3f6afba4"
      }
    },
    "stage": {
      "title": "Example Stage Title",
      "id": "19ee9327-4f66-43d8-96cb-57ae3f6afba4",
      "parent_id": "19ee9327-4f66-43d8-96cb-57ae3f6afba4"
    }
  }
}

Response

Request handled. Returned when the referral application was updated for a stage change, when the incoming status matched the current one (no-op), or when no referral application exists for the given utm_content (nothing to update).

successboolean

Example response

{
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.