Notes

Create a note

Leave a note on the campaign itself (campaign, no target) or on one of its suppliers or buyers (suppliers / buyers, target required).

The note is attributed to whoever the token belongs to - the account owner, a team member, or Lead Prosper support - and appears in the application immediately. Plain text, up to 2,000 characters.

post/v2/campaigns/{campaign}/notes/{scope}/{target}

Request

  • Base URL: https://api.leadprosper.io/public
  • URL: https://api.leadprosper.io/public/v2/campaigns/{campaign}/notes/{scope}/{target}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_token

Path parameters

campaigninteger required

Campaign id.

scope'campaign' | 'suppliers' | 'buyers' required

campaign, suppliers or buyers.

targetinteger

The supplier or buyer id. Required unless the scope is campaign.

Request body

notestring required

The note, plain text.

Example request

{
  "note": "Asked them to raise the daily cap."
}

Response

Success

dataobject

The note as created, in the same shape the list publishes.

Changes

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