RecruitAffiliates.ai

Save prospects

Free: saving never spends a credit. Each newly saved prospect gets a deal from the brand's default offer; with no offer yet, needs_offer is true.

Scope: finder:write

post/v1/finder/prospects/save

Request

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

Request body

idsstring[] required

1 to 100 prospect ids

list_idstring

Also put them on this list

Example request

{
  "ids": [
    "fdi_7uSyy9FqVLCFWrdPeZaK"
  ],
  "list_id": "fls_7uSyy9FqVLCFWrdPeZaK"
}

Response

What was saved

object'finder_save_result' required
savedstring[] required

The ids that weren't saved before this call

needs_offerboolean required

True when the brand has no default offer yet, so these have no deal until one is written

Example response

{
  "saved": [
    "fdi_7uSyy9FqVLCFWrdPeZaK"
  ]
}

Changes

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