Skip to main content
POST
/
prod
/
site
/
{id}
/
settings
Update Website Settings
curl --request POST \
  --url https://api.aimtell.com/prod/site/{id}/settings \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization-Api-Key: <api-key>' \
  --data '
{
  "collect_ip": 1,
  "collect_ip_as_attribute": 0,
  "collect_suburl": 0,
  "collect_ua_as_attribute": 1,
  "track_clicks_as_events": 0,
  "track_subscribe_as_event": 0,
  "retention_length": "30",
  "frequency_cap": 15
}
'
{
  "result": "success",
  "message": "Updated site settings"
}

Authorizations

​
X-Authorization-Api-Key
string
header
default:""
required

Path Parameters

​
id
string
required

Site ID

Body

application/json
​
collect_ip
integer<int32>
default:1
required

Allow collection of IP Address (0 = false, 1 = true)

​
collect_ip_as_attribute
integer<int32>
default:0
required

Automatically track IP address as a custom attribute (0 = false, 1 = true)

​
collect_suburl
integer<int32>
default:0
required

Automatically track subscription URL as custom attribute (0 = false, 1 = true)

​
collect_ua_as_attribute
integer<int32>
default:1
required

Automatically track User Agent as custom attribute (0 = false, 1 = true)

​
track_clicks_as_events
integer<int32>
default:0
required

Automatically track notification clicks as custom events. (0 = false, 1 = true)

​
track_subscribe_as_event
integer<int32>
default:0
required

Automatically track subscriptions as custom events. (0 = false, 1 = true)

​
retention_length
integer<int32>
default:30
required

Number of days to keep data for deleted subscribers

​
frequency_cap
integer<int32>
default:15
required

Max number of notifications a subscriber can receive per day

Response

200