Web API

Update activation

put
https://{account}.piwik.pro/api/cdp/settings/v1/app//activation/

Update a single activation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID of the app.

uuid
required

ID of the object.

Body Params

Activation update object

Common parts of all type of activation update objects

string
required
length ≤ 100

Activation name

string
required
length ≤ 200

Activation description

string
enum
required

Activation status. active enables profiles activation, inactive disables profile activation. If activation has no audience associated with it, Activation API will always return inactive.

Allowed:
string
enum
required

Signal that triggers an activation. onjoin makes joining an audience trigger activation. onleave makes leaving an audience trigger activation.

Allowed:
uuid
required

ID of an audience to be activated

required_consents
array of strings
required

Consent types a profile must contain to be activated

required_consents*
boolean
required

Whether one profile can be activated multiple times

boolean
required

Whether a profile containing more than one user ID can be activated

const
enum
required

Type of activation

Allowed:
string
required

Webhook URL pointing at some external system

webhook_body_attributes
array of objects

Profile's attributes used in a simple webhook request. Used for constructing body template on front-end.

webhook_body_attributes
string
required

Template of a webhook request body with attribute placeholders. Backend fills this template with profile attributes and sends it to webhook_url.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 18 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 18 days ago