RecruitAffiliates.ai

Create a deal

A deal for a saved prospect, from the brand's default offer. Send terms to offer different ones straight away, as the next version. A prospect that already has a deal gets that deal back, with 200 instead of 201.

Scope: finder:write

post/v1/finder/deals

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/finder/deals
  • Auth: HTTP bearer

Request body

prospect_idstring required

A saved prospect. The deal starts from the brand's default offer.

Example request

{
  "prospect_id": "fdi_7uSyy9FqVLCFWrdPeZaK"
}

Response

The deal the prospect already had

idstring required

Prefixed id (fdl_…)

object'finder_deal' required
brand_idstring required

Prefixed id (fbr_…)

prospect_idstring required

Prefixed id (fdi_…)

prospect_namestring required
status'saved' | 'agreed' | 'activated' required

saved terms can change. agreed and activated are frozen.

versioninteger required

Goes up by one each time new terms are offered

terms_summarystring nullable required
verdict'recommended' | 'yes_but_expensive' | 'overpriced' | 'maybe_later' | 'not_recommended' | 'null' nullable required
their_askstring nullable required
notesstring nullable required
agreed_atstring date-time nullable required

ISO-8601, UTC

created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "fdl_7uSyy9FqVLCFWrdPeZaK",
  "brand_id": "fbr_7uSyy9FqVLCFWrdPeZaK",
  "prospect_id": "fdi_7uSyy9FqVLCFWrdPeZaK",
  "agreed_at": "2026-08-21T10:15:30.000Z",
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z",
  "versions": [
    {
      "created_at": "2026-08-21T10:15:30.000Z"
    }
  ]
}

Changes

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