When a visitor signs up for non-transactional (meaning, promotional) content, such as a newsletter, they are consenting to receive marketing messages. This agreement is called a marketing consent. A marketing consent holds the visitor's sign-up details such as email address or phone number, the status of the consent, and more.
The Marketing Consent API allows you to manage a site's marketing consents. With the Marketing Consent API, you can:
You can also listen for events when a visitor's marketing consent is created, updated, and deleted.
A marketing consent has an optInLevel
of either single or double confirmation. Some countries require double confirmation for all marketing consents. With single confirmation, when a site visitor signs up, their marketing consent state
is CONFIRMED
. With double confirmation, when a site visitor signs up, their marketing consent state
is PENDING
until the visitor confirms their consent, for example, by clicking a link to verify their email address. When the visitor confirms their consent, the state
is CONFIRMED
.
The Get Marketing Consent By Identifier method returns the communicationEligibility.granted
boolean which determines whether the recipient of the marketing consent is eligible to receive marketing messages. Note that this only serves as a signal for you to decide whether or not you should send marketing messages to the recipient's email address or phone number.
For example:
CommunicationEligibility.granted
is false
. This applies to marketing consents made by both phone and email.state
is NEVER_CONFIRMED
, the visitor has never confirmed to receive communication, and CommunicationEligibility.granted
is false
. This applies only to marketing consents made by phone. If a visitor made a marketing consent by email and the state
is NEVER_CONFIRMED
, the visitor can still receive communication, and CommunicationEligibility.granted
is true
.Visitor: A visitor is any person who visits a site, including contacts, non-contacts, members, and non-members.
Communication channel: Each marketing consent has a communication channel of either email
or phone
. A visitor can sign up multiple times using different email addresses and phone numbers, however, they can only create a single marketing consent per email and per phone number.
State: Different states of a marketing consent:
UNKNOWN_STATE
: State of the marketing consent is unknown.NEVER_CONFIRMED
: The visitor never confirmed to receive marketing messages.REVOKED
: The marketing consent has been removed, for example, when a visitor unsubscribes from a newsletter.PENDING
: The marketing consent is pending confirmation. Relevant only for {"optInLevel": "DOUBLE_CONFIRMATION"}
.CONFIRMED
: The site visitor has confirmed their marketing consent.Opt in level: A marketing consent can require either single or double confirmation, as some countries require double confirmation for all marketing consents.
Communication eligibility: A signal for you to easily check whether or not you can send marketing messages to the recipient's email address or phone number.
This article shares some possible use cases your app could support, as well as an example flow that could support each use case. You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your app's implementation.
A visitor signs up on your app to receive non-transactional content. If the visitor is from a country where the opt in level is double confirmation, follow this flow to create the marketing consent and update the visitor's marketing consent state.
To confirm the marketing consent:
state
property of the response is PENDING
until the visitor confirms the sign up.PENDING
to CONFIRMED
.The table below shows field support for filters and sorting for the base set of marketing consent properties.
Field | Supported Filters | Sortable |
---|---|---|
id | $eq , $ne , $in , $exists | |
createdDate | $eq , $ne , $gt , $lt , $gte , $lte | Sortable |
updatedDate | $eq , $ne , $gt , $lt , $gte , $lte | Sortable |
details.email | $eq , $ne , $in , $exists , $startsWith | |
details.phone | $eq , $ne , $in , $exists , $startsWith | |
state | $eq , $ne , $in |
Marketing consent ID.
Revision number.
Marketing consent communication details.
Marketing consent state.
Default: UNKNOWN_STATE
.
Date and time the marketing consent was created.
Date and time the marketing consent was updated.
Last confirmation activity of the marketing consent.
Last revoke activity of the marketing consent.
Additional fields.
{
"id": "aa8a62f5-9a79-4b21-b1a4-5c835c08d937",
"revision": "1",
"details": {
"type": "EMAIL",
"email": "test@test.com"
},
"state": "CONFIRMED",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Person filed a printed document",
"updatedDate": "2022-10-02T08:43:25.765Z",
"optInLevel": "UNKNOWN_OPT_IN_LEVEL"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
}
Retrieves a marketing consent.
You can only call this method when authenticated as a Wix app or Wix user identity.
Marketing consent ID.
The requested marketing consent.
curl -X GET \
'https://www.wixapis.com/marketing-consent/v1/marketing-consent/22916e0c72-afe4-41a2-9b88-75888559a904' \
-H 'Authorization: <AUTH>'
{
"marketingConsent": {
"id": "22916e0c72-afe4-41a2-9b88-75888559a904",
"revision": "1",
"details": {
"type": "EMAIL",
"email": "mytest@test.com"
},
"state": "CONFIRMED",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Confirmed by Samantha.",
"updatedDate": "2022-10-03T00:00:00Z",
"optInLevel": "UNKNOWN_OPT_IN_LEVEL"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
}
}
Deletes a marketing consent.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of the marketing consent to delete.
curl -X DELETE \
'https://www.wixapis.com/marketing-consent/v1/marketing-consent/2178v046df3c-7575-4098-a5ab-c91ad8f33c47' \
-H 'Authorization: <AUTH>'
{}
Retrieves a marketing consent by its details. Required fields:
details.type
.details.email
OR details.phone
.Note: Due to the ongoing development of our new documentation portal, the query parameter is not displaying as expected. Use the details
object located in the marketing consent object in the request. You can also see the code example for reference.
You can only call this method when authenticated as a Wix app or Wix user identity.
The communication channel of the marketing consent.
Language of the page
The requested marketing consent.
Details about whether the subject of the marketing consent is eligible to receive marketing messages.
curl -X GET \
https://www.wixapis.com/marketing-consent/v1/marketing-consent/get-by \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d '{
"details": {
"type": "EMAIL",
"email": "yourtest@test.com"
}
}'
{
"marketingConsent": {
"id": "830c41d3-5bd6-4bd2-a8db-762de4c00c2c",
"revision": "1",
"details": {
"type": "EMAIL",
"phone": "yourtest@test.com"
},
"state": "CONFIRMED",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Confirmed by Jack.",
"updated_date": "2021-07-22T00:00:00Z",
"optInLevel": "SINGLE_CONFIRMATION"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
},
"communicationEligibility": {
"grated": true,
"revokeConfirmationLink": "https://some.domain/_manage-consent/unsubscribe?token=JWE.eyJhbGciOiJBMTI4S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2Iiwia2lkIjoiZkhJbFA4M1cifQ.3s9htG9Q_DJGbZ6s2qKIo350XNMxzxujkRE2Vi6DMU3IEyHqTHjVyQ.LQXW1jqTYB1lb6Y3aBOong.8O6yjksDWq0GMQGbDj7LARMRYQdTEgLty8kupvByr8SVgS5ClRN5ID5sXE1gH7wgORJUEKOwUossD06C5PujK87In6OF3dXWR4dpED0cLEWWS8v9FHzMC-1CTaOvsh6n8m4oNGqKkw9Lfg0LY4ZLjjlM72q_A07UQ9igGZXyX7Y3VFZqVsbUjp8mnbVWTOhVbnAthVLp9Yd5y2RZUVNwwuUaLuVHW-EE9hHyka69lOeSAntBP0Ntxx8zv9-if96p0ynifLMXuFQjeCD711gg2w.qL-xWjmUZS1HPHIeN8MaPA",
"reason": ""
}
}
Creates a confirmed marketing consent with a state
of CONFIRMED
.
Required fields:
details.type
.details.email
OR details.phone
.lastConfirmationActivity
.To create a marketing consent with a different state, use Upsert Marketing Consent, or Bulk Upsert Marketing Consent.
You can only call this method when authenticated as a Wix app or Wix user identity.
Marketing consent to create.
Newly created marketing consent.
Marketing consent confirmation link.
curl -X POST \
'https://www.wixapis.com/marketing-consent/v1/marketing-consent' \
-H 'Authorization: <AUTH>'
--data-binary '{
"marketingConsent": {
"details": {
"type": "PHONE",
"phone": "+19172222222"
},
"lastConfirmationActivity": {
"source": "LINK_CONFIRMATION",
"description": "Law requires double confirmation.",
"optInLevel": "DOUBLE_CONFIRMATION"
}
}
}'
{
"marketingConsent": {
"id": "aa8a62f5-9a79-4b21-b1a4-5c835c08d937",
"revision": "1",
"details": {
"type": "PHONE",
"phone": "+19172222222"
},
"state": "CONFIRMED",
"lastConfirmationActivity": {
"source": "LINK_CONFIRMATION",
"description": "Law requires double confirmation",
"updatedDate": "2023-05-13T00:00:00Z",
"optInLevel": "DOUBLE_CONFIRMATION"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
},
"link": {
"type": "REVOKE_CONFIRMATION",
"url": "https://some-domain/_manage-consent/unsubscribe?token=JWE.eyJhbGciOiJBMTI4S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2Iiwia2lkIjoiZkhJbFA4M1cifQ.RakF3_XlktSPIDsOmq3lt2RsP4PxxXe3UAxQNirF1IWGmrrfgc7jnw.tuqC5Sep852Xuu_P_b8g-w.Ogg8m7mo5Lyg2Ee36xFdoszktS2RrIWq0z1ziW4M_zfx0yDyMcCCiUWScd1tm_BP0xxHtfPw2dInZCFNR2GhhelA5c2Qvlpu8fUZgHg-gnWKvMf_OZDu2GeaRaTJuGOp6T27cF6t9EThyyy1gxsyBiQk_r4tH6WoFcKAJhH1dec7L0L7i3Cu3fQ7frFgbadKX4PYx1-llqaeKVw9gwfQdvI5Aj1n95AMIHfnwZpi1MqU-zPq8xPDU9HSP5ZH1RELmeQJqWbl-n_0Q7NdhO9NQw.h7Wn-AACmFkHIPMDJlJTRQ"
}
}
Updates a marketing consent. Required fields:
details.type
.details.email
OR details.phone
.state
.When a marketing consent's state
is PENDING
or CONFIRMED
, the info.lastConfirmationActivity
field is required.
When a marketing consent's state
is REVOKED
, the info.lastRevokeActivity
field is required.
Note: For existing marketing consents with {"type": "EMAIL"}
, you can't update the state
to UNKNOWN_STATE
. Trying to do so maintains the current state. However, you can create a new marketing consent and set the state
to UNKNOWN_STATE
. Note that you can't create more than a single consent per email or phone number.
You can only call this method when authenticated as a Wix app or Wix user identity.
Marketing consent ID.
Marketing consent to update.
Explicit list of fields to update
Updated marketing consent.
Marketing consent confirmation or cancelation link.
curl -X PATCH \
https://www.wixapis.com/marketing-consent/v1/marketing-consent/aa8a62f5-9a79-4b21-b1a4-5c835c08d937 \
-H 'Authorization: <AUTH>'
-d '{
"marketingConsent": {
"details": {
"type": "EMAIL",
"email": "mytest@test.com"
},
"state": "REVOKED",
"revision": 3,
"lastConfirmationActivity": {
"source": "IN_PERSON"
}
},
"mask": {
"paths": [
"state",
"lastConfirmationActivity.source"
]
}
}'
{
"marketingConsent": {
"id": "aa8a62f5-9a79-4b21-b1a4-5c835c08d937",
"revision": "3",
"details": {
"type": "EMAIL",
"email": "mytest@test.com"
},
"state": "REVOKED",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "person filled a printed document",
"updatedDate": "2023-01-01T00:00:00Z",
"optInLevel": "DOUBLE_CONFIRMATION"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
}
}
Removes a marketing consent. The consent is cancelled, and the state
is updated to REVOKED
.
The marketing consent entity still exists, but the recipient is no longer eligible to receive communication.
To delete a marketing consent entirely, use Delete Marketing Consent.
Required fields:
details.type
.details.email
OR details.phone
.info.lastRevokeActivity
.You can only call this method when authenticated as a Wix app or Wix user identity.
Marketing consent communication details.
Information about the last revoke.
The canceled marketing consent.
curl -X POST \
'https://www.wixapis.com/marketing-consent/v1/marketing-consent/remove' \
-H 'Authorization: <AUTH>'
-d '{
"details": {
"type": "PHONE",
"phone": "+445168993333"
}
}'
{
"marketingConsent": {
"id": "aa8a62f5-9a79-4b21-b1a4-5c835c08d937",
"revision": "2",
"details": {
"type": "PHONE",
"phone": "+445168993333"
},
"state": "REVOKED",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Canceling the confirmation",
"updatedDate": "2023-01-03T00:00:00Z",
"optInLevel": "SINGLE_CONFIRMATION"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
}
}
Retrieves a list of marketing consents, given the provided paging, filtering, and sorting. Up to 100 marketing consents can be returned per request.
The default sort
is id
in ASC
order. For a detailed list of supported operations, see filtering and sorting for marketing consent properties. To learn how to query marketing consents, see API Query Language.
You can only call this method when authenticated as a Wix app or Wix user identity.
Query options.
List of marketing consents.
Details on the paged set of results returned.
curl -X PATCH \
https://www.wixapis.com/marketing-consent/v1/marketing-consent/query \
-H 'Authorization: <AUTH>'
-d '{
"query": {
"sort": [],
"filter": {
"details.email": "test@test.com"
},
"cursor_paging": {
"limit": 1
}
}
}'
{
"marketingConsent": [
{
"id": "aa8a62f5-9a79-4b21-b1a4-5c835c08d937",
"revision": "6",
"details": {
"type": "EMAIL",
"email": "test@test.com"
},
"state": "REVOKED",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "person filled a printed document",
"updatedDate": "2023-01-01T00:00:00Z",
"optInLevel": "DOUBLE_CONFIRMATION"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
}
],
"pagingMetadata": {
"count": 1,
"cursors": {
"next": null,
"prev": null
},
"hasNext": false
}
}
Creates or updates a marketing consent. Required fields:
details.type
.details.email
OR details.phone
.state
.When a marketing consent's state
is PENDING
or CONFIRMED
, the info.lastConfirmationActivity
field is required.
When a marketing consent's state
is REVOKED
, the info.lastRevokeActivity
field is required.
Note: For existing marketing consents with {"type": "EMAIL"}
, you can't update the state
to UNKNOWN_STATE
. Trying to do so maintains the current state. However, you can create a new marketing consent and set the state
to UNKNOWN_STATE
. Note that you can't create more than a single consent per email or phone number.
You can only call this method when authenticated as a Wix app or Wix user identity.
Marketing consent to create or update.
Newly created or updated marketing consent.
Marketing consent confirmation or cancelation link.
curl -X POST \
https://www.wixapis.com/marketing-consent/v1/marketing-consent/upsert \
-H 'Authorization: <AUTH>'
-d '{
"details": {
"type": "EMAIL",
"email": "test@test.com"
},
"state": "PENDING",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Person filled a printed document.",
"updated_date": "2023-05-01T00:00:00Z",
"optInLevel": "DOUBLE_CONFIRMATION"
}
}'
{
"marketingConsent": {
"id": "aa8a62f5-9a79-4b21-b1a4-5c835c08d937",
"revision": "3",
"details": {
"type": "EMAIL",
"email": "test@test.com"
},
"state": "PENDING",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Person filled a printed document.",
"updated_date": "2023-05-01T00:00:00Z",
"optInLevel": "DOUBLE_CONFIRMATION"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
},
"link": {
"type": "CONFIRMATION",
"url": "https://some-domain/_manage-consent/subscribe?token=JWE.eyJhbGciOiJBMTI4S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2Iiwia2lkIjoiZkhJbFA4M1cifQ.l0rBPnrV81dCCO2SWFce15SwFhMWpa-ts2z9aeC4BB9Dh1Pveo2x9Q.q2FnvSlGJ6pEfDDsvo1U0A.BTTYsIwIn59_vW6N7oicfB2LoQHkP8Hqrzs2pM4DYYIp3c7cIUrFEv1e3kxBvab3a17nhypf9xVEDTwT-ZfWzLhdlvodtHGN4LW73azS98hhME5klJR6GgQEQrkJo9dumQNTN2WOswttB05IjoYIjHPQsrNSzY1-iWf36Qbxc1iCxhjlsG0NMjO76CgaLlr1DnMV4PF4J1CPupDr_1-n2oX4trQY0G0S7C7Jx8grZqIgKFM0p9oE0RLju2kCp-Ck0YTKB9KEqYt3CZkvygVqvA.TN0Ec9bGgivYSGJOVrLbeA"
}
}
Creates or updates multiple marketing consents. Required fields:
details.type
.details.email
OR details.phone
.state
.When a marketing consent's state
is PENDING
or CONFIRMED
, the info.lastConfirmationActivity
field is required.
When a marketing consent's state
is REVOKED
, the info.lastRevokeActivity
field is required.
Note: For existing marketing consents with {"type": "EMAIL"}
, you can't update the state
to UNKNOWN_STATE
. Trying to do so maintains the current state. However, you can create a new marketing consent and set the state
to UNKNOWN_STATE
. Note that you can't create more than a single consent per email or phone number.
You can only call this method when authenticated as a Wix app or Wix user identity.
List of marketing consent information to update or create.
List of created or updated marketing consents.
Numbers of successful and failed actions.
curl -X POST \
https://www.wixapis.com/marketing-consent/v1/bulk/marketing-consent/upsert \
-H 'Authorization: <AUTH>'
-d '{
"info" : [
{
"details": {
"type": "EMAIL",
"email": "test1@test.com"
},
"state": "PENDING",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Person filed a printed document.",
"updatedDate": "2023-01-01T00:00:00Z",
"optInLevel": "DOUBLE_CONFIRMATION"
}
},
{
"details": {
"type": "EMAIL",
"email": "test2@test.com"
},
"state": "CONFIRMED",
"lastConfirmationActivity": {
"source": "LINK_CONFIRMATION",
"description": "Person clicked a link.",
"updatedDate": "2023-01-03T00:00:00Z",
"optInLevel": "SINGLE_CONFIRMATION"
}
}
]
}'
{
"results": [
{
"originalIndex": 0,
"marketingConsent": {
"id": "f5d258dd-64e9-49f6-b8af-2b5b616ddb22",
"details": {
"type": "EMAIL",
"email": "test1@test.com"
},
"state": "PENDING",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Person filed a printed document.",
"updatedDate": "2023-01-01T00:00:00Z",
"optInLevel": "DOUBLE_CONFIRMATION"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
},
"link": {
"type": "CONFIRMATION",
"url": "https://rebeccask.wixsite.com/testing-test-sites/_manage-consent/subscribe?token=JWE.eyJhbGciOiJBMTI4S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2Iiwia2lkIjoiZkhJbFA4M1cifQ.UmKgcTrpm13hqOqrrbKBC6sLTK7ZF694DN9ozHFFXhB9l_0TZBIOfw.7Qhmn9yQl99V0z8wzlMHGQ.dpcSFTlxBJeh52asYrarRcYL1KVkDRs8zUTT4jrC7gFhFIHn-S678kDO4FSSwM92Ncg7nrq-A9d5hWkdeg5EQTq4A3Ludxxt3YjQnfVOUWggYXvdsoWcSh6UNqt3FKoXtVDHBJQDRJun2LVJ_IDbBPo8O89Y0bJ72d5S2hlOCrul8bj72nYDY1Mcrc4gSabbM5cRVmJuVSJJwU2ProAwUlC4RCi9bvKM7ZnonbFSsqzO4pfoKOs6Rl0JDTIe-Z0r7vwkq1uhdN5DlQkDN9PD0g.VJAjLxKf0xcIpocwcjZXOA"
}
},
{
"originalIndex": 1,
"marketingConsent": {
"id": "a4f96b5b-1ab6-48e9-91d7-8317466fe801",
"details": {
"type": "EMAIL",
"email": "test2@test.com"
},
"state": "CONFIRMED",
"lastConfirmationActivity": {
"source": "LINK_CONFIRMATION",
"description": "Person clicked a link",
"updatedDate": "2023-01-03T00:00:00Z",
"optInLevel": "SINGLE_CONFIRMATION"
},
"extendedFields": {}
},
"link": {
"type": "REVOKE_CONFIRMATION",
"url": "https://rebeccask.wixsite.com/testing-test-sites/_manage-consent/unsubscribe?token=JWE.eyJhbGciOiJBMTI4S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2Iiwia2lkIjoiZkhJbFA4M1cifQ.2Rrc2yCSu8hAtQ2R-QVqOowE6VaJ4Tz2CrF9yYahoGylKQhiaxkB9g.t31uuAdT2d__GZ5RhltuwQ._MkLlPHPy05IwOgNFYgH5et8D_ujdheZUa9SLFnTxDfCFGSBXWaE4SxxKKx8hJAFf5qo8s5HnLUHUHCC_T0ve6k8xyzB86dUZTLTt_Y_20xY3Bolxh6e8DC1-0mYS6Ufs9FInvTt4nSP3FtMvItk9DPkOFOaFyHXObGqwW9lXpijCcvVXJemWzsiEwIknc291W8hUSwWnqlvPZG6i05Umq03Mwf8-7Wk0KdYRC5xcY7nzTZ0ax1SQ_zh2LcKTDC2RIKGAkx-m9fTBDAQwBfwfg.jXxMG8F5v3IgtokmQPKD_Q"
}
}
],
"metadata": {
"totalSuccess": 2,
"totalFailure": 0
}
}
Triggered when a marketing consent is created.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.marketing.marketing_consent.v1.marketing_consent
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.marketing.marketing_consent.v1.marketing_consent_created",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "816e0c72-afe4-41a2-9b88-75888559a904",
"entityFqdn": "wix.marketing.marketing_consent.v1.marketing_consent",
"slug": "created",
"entityId": "0f32c763-e797-42cc-ba93-b9032bc99464",
"createdEvent": {
"entity": {
"id": "aa8a62f5-9a79-4b21-b1a4-5c835c08d937",
"revision": "1",
"details": {
"type": "EMAIL",
"email": "test@test.com"
},
"state": "CONFIRMED",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Person filed a printed document",
"updatedDate": "2022-10-02T08:43:25.765Z",
"optInLevel": "UNKNOWN_OPT_IN_LEVEL"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
}
},
"eventTime": "2023-05-18T19:18:39.199886Z",
"triggeredByAnonymizeRequest": false
}
Triggered when a marketing consent is deleted.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.marketing.marketing_consent.v1.marketing_consent
.
Event name. Expected deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.marketing.marketing_consent.v1.marketing_consent_deleted",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "0827265a-f54c-4d2d-aafc-892eaf549220",
"entityFqdn": "wix.marketing.marketing_consent.v1.marketing_consent",
"slug": "deleted",
"entityId": "aa8a62f5-9a79-4b21-b1a4-5c835c08d937",
"deletedEvent": {
"movedToTrash": true
},
"eventTime": "2023-05-18T19:30:11.911298Z",
"triggeredByAnonymizeRequest": false
}
Triggered when a marketing consent is updated.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.marketing.marketing_consent.v1.marketing_consent
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.marketing.marketing_consent.v1.marketing_consent_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "e318e485-92f3-4ea1-ac7f-9b3d0ec572bb",
"entityFqdn": "wix.marketing.marketing_consent.v1.marketing_consent",
"slug": "updated",
"entityId": "0f32c763-e797-42cc-ba93-b9032bc99464",
"updatedEvent": {
"currentEntity": {
"id": "aa8a62f5-9a79-4b21-b1a4-5c835c08d937",
"revision": "1",
"details": {
"type": "EMAIL",
"email": "test@test.com"
},
"state": "CONFIRMED",
"lastConfirmationActivity": {
"source": "IN_PERSON",
"description": "Person filed a printed document",
"updatedDate": "2022-10-02T08:43:25.765Z",
"optInLevel": "UNKNOWN_OPT_IN_LEVEL"
},
"extendedFields": {},
"created_date": "2022-11-16T14:07:50.150Z",
"updated_date": "2022-11-16T14:07:50.150Z"
}
},
"eventTime": "2023-05-18T19:21:45.238639Z",
"triggeredByAnonymizeRequest": false
}