---
title: "Process a referral campaign request"
method: POST
path: "/api/servicereferral/processes/referralCampaigns"
tags: ["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

- object
  - `applicant` object, required
    - `email` string, required
    - `name` string, required
    - `first_name` string, required
    - `last_name` string, required
    - `phone_number` string, required
    - `normalized_phone_number` string, required
    - `phone_number_country_code` string, required
    - `data` object, required
    - `created_at` string, required
    - `id` string, required
    - `background_checks` union[], required
      - union
        - object
          - `status` 'clear' | 'consider' | 'negative' | 'non_negative' | 'complete' | 'pending' | 'suspended' | 'dispute' | 'canceled', required
          - `title` string, required
          - `updated_at` string, required
          - `candidate_id` string, required
          - `report_id` string, required
          - `vendor` 'checkr', required
        - object
          - `title` string, required
          - `applicant_id` string, required
          - `updated_at` string, required
          - `status` 'no bgc' | 'pending' | 'consented' | 'not consented' | 'clear' | 'consider' | 'withdrawn' | 'paused' | 'reopened', required
          - `check_id` string, required
          - `vendor` 'onfido', required
    - `work_availability` 'sunday_morning' | 'sunday_afternoon' | 'sunday_evening' | 'monday_morning' | 'monday_afternoon' | 'monday_evening' | 'tuesday_morning' | 'tuesday_afternoon' | 'tuesday_evening' | 'wednesday_morning' | 'wednesday_afternoon' | 'wednesday_evening' | 'thursday_morning' | 'thursday_afternoon' | 'thursday_evening' | 'friday_morning' | 'friday_afternoon' | 'friday_evening' | 'saturday_morning' | 'saturday_afternoon' | 'saturday_evening'
    - `date_of_birth` string
    - `funnel` object, required
      - `title` string, required
      - `custom_id` string, required
      - `id` string, required
      - `location` object
        - `name` string, required
        - `id` string, required
        - `latitude` number, required
        - `longitude` number, required
        - `location_group` object, required
          - `name` string, required
          - `id` string, required
      - `position` object
        - `name` string, required
        - `id` string, required
    - `stage` object, required
      - `title` string, required
      - `id` string, required
      - `parent_id` string, required
      - `type` string, required
    - `score_card_results` object[]
  - `utm_source` string
  - `utm_content` string, 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_term` string
  - `utm_medium` string
  - `utm_campaign` string
  - `status` 'self_identified' | 'applied' | 'hired' | 'rejected' | 'stage_changed', required
  - `applicantSource` string

## Response `200`

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).

- object
  - `meta` ResponsesPartMeta
    - `timestamp` string, date-time, required
    - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
    - `path` string
    - `jti` string
    - `rid` string
    - `count` number
    - `capped` boolean: The server lowered filter[limit] to its ceiling. Page with filter[skip] to read past it.
    - `status` string
    - `duration` number
    - `size` number
  - `success` boolean

## Other responses

- `201`: Referral application status updated (applied / hired / rejected)
- `400`: Invalid payload — a required field is missing or utm_content is not a uuid

---

[API](https://skmtc.dev/fountain/apis/worker-experience-public-api.md) - [All operations](https://skmtc.dev/fountain/apis/worker-experience-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fountain/apis/worker-experience-public-api/revisions/6b9a31f79e22?raw)