Skip to main content
POST
/
cpl
/
offers
/
{id}
/
note
Set or clear the per-user note on a CPL offer.
curl --request POST \
  --url https://studio-api.onlytraffic.com/api/external/v1/cpl/offers/{id}/note \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "note": "<string>"
}
'
{
  "success": true,
  "data": {
    "offer_id": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

Your API key from the Studio Dashboard

Path Parameters

​
id
integer
required

Numeric resource id.

Required range: x >= 1

Body

application/json
​
note
string

Up to 1000 characters. Pass an empty string or omit to clear any existing note.

Maximum string length: 1000

Response

Saved.

​
success
boolean
​
data
object