RecruitAffiliates.ai

Hide prospects

Not a fit. Soft, never a delete: the rows move to the hidden view and restore brings them back.

Scope: finder:write

post/v1/finder/prospects/hide

Request

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

Request body

idsstring[] required

1 to 100 prospect ids

reason'sells_own_product' | 'wrong_audience' | 'too_small' | 'too_big' | 'not_my_topic' | 'other' required

Why they're not a fit. Some reasons also tune the brand's settings; effects in the answer says which.

Example request

{
  "ids": [
    "fdi_7uSyy9FqVLCFWrdPeZaK"
  ]
}

Response

What was hidden

object'finder_hide_result' required
hiddenstring[] required
effectsobject[] required

What the reason changed in the brand's settings, if anything

Example response

{
  "hidden": [
    "fdi_7uSyy9FqVLCFWrdPeZaK"
  ]
}

Changes

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