Skip to content
Clym

Consent

Consent export, reset, and Google Consent Mode events.

Triggered when a consent export file is ready.

Request bodyapplication/json
eventstringrequired
The `consent.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property record.
Show properties
kindstringenumoptional
Entity type; always `property`.
Possible values: property
dataobjectoptional
Property entity
Show properties
idstringoptional
Property ID
company_idstringoptional
Company ID
namestringoptional
Property name
descriptionstringoptional
Property description
typestringenumoptional
Property type
Possible values: DOMAIN OFFLINE
statusstringenumoptional
Property status
Possible values: NEW INVITED SCANNED ACTIVE
is_setupbooleanoptional
Whether setup is complete
is_verifiedbooleanoptional
Whether the domain is verified
is_watermark_disabledbooleanoptional
Whether the watermark is disabled
is_limitedbooleanoptional
Whether the property is limited
limited_atstringnullableoptional
is_subscription_activebooleanoptional
Whether the subscription is active
is_gpp_enabledbooleanoptional
Whether IAB GPP is enabled
send_details_of_dsarbooleanoptional
Whether DSAR details are emailed
dsr_auto_openbooleanoptional
dsr_auto_progressbooleanoptional
dsr_auto_closedbooleanoptional
emailstring[]optional
Notification email addresses
email_signaturestringoptional
widget_typestringenumoptional
Possible values: V1 V2
widget_versionstringoptional
country_idstringnullableoptional
Country code
state_idstringnullableoptional
State/region code
industry_idintegernullableoptional
sector_idintegernullableoptional
mspa_covered_transactionstringenumoptional
Possible values: YES NO
mspa_opt_out_option_modestringenumoptional
Possible values: NOT_APPLICABLE YES NO
mspa_service_provider_modestringenumoptional
Possible values: NOT_APPLICABLE YES NO
activated_atstringnullableoptional
reset_atstringnullableoptional
created_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "consent.reset",
  "params": {},
  "entity": {
    "kind": "property",
    "data": {
      "id": "string",
      "company_id": "string",
      "name": "string",
      "description": "string",
      "type": "DOMAIN",
      "status": "NEW",
      "is_setup": false,
      "is_verified": false,
      "is_watermark_disabled": false,
      "is_limited": false,
      "limited_at": "string",
      "is_subscription_active": false,
      "is_gpp_enabled": false,
      "send_details_of_dsar": false,
      "dsr_auto_open": false,
      "dsr_auto_progress": false,
      "dsr_auto_closed": false,
      "email": ["string"],
      "email_signature": "string",
      "widget_type": "V1",
      "widget_version": "string",
      "country_id": "string",
      "state_id": "string",
      "industry_id": 0,
      "sector_id": 0,
      "mspa_covered_transaction": "YES",
      "mspa_opt_out_option_mode": "NOT_APPLICABLE",
      "mspa_service_provider_mode": "NOT_APPLICABLE",
      "activated_at": "string",
      "reset_at": "string",
      "created_at": "string"
    }
  }
}

Triggered when property consent records are reset.

Request bodyapplication/json
eventstringrequired
The `consent.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property record.
Show properties
kindstringenumoptional
Entity type; always `property`.
Possible values: property
dataobjectoptional
Property entity
Show properties
idstringoptional
Property ID
company_idstringoptional
Company ID
namestringoptional
Property name
descriptionstringoptional
Property description
typestringenumoptional
Property type
Possible values: DOMAIN OFFLINE
statusstringenumoptional
Property status
Possible values: NEW INVITED SCANNED ACTIVE
is_setupbooleanoptional
Whether setup is complete
is_verifiedbooleanoptional
Whether the domain is verified
is_watermark_disabledbooleanoptional
Whether the watermark is disabled
is_limitedbooleanoptional
Whether the property is limited
limited_atstringnullableoptional
is_subscription_activebooleanoptional
Whether the subscription is active
is_gpp_enabledbooleanoptional
Whether IAB GPP is enabled
send_details_of_dsarbooleanoptional
Whether DSAR details are emailed
dsr_auto_openbooleanoptional
dsr_auto_progressbooleanoptional
dsr_auto_closedbooleanoptional
emailstring[]optional
Notification email addresses
email_signaturestringoptional
widget_typestringenumoptional
Possible values: V1 V2
widget_versionstringoptional
country_idstringnullableoptional
Country code
state_idstringnullableoptional
State/region code
industry_idintegernullableoptional
sector_idintegernullableoptional
mspa_covered_transactionstringenumoptional
Possible values: YES NO
mspa_opt_out_option_modestringenumoptional
Possible values: NOT_APPLICABLE YES NO
mspa_service_provider_modestringenumoptional
Possible values: NOT_APPLICABLE YES NO
activated_atstringnullableoptional
reset_atstringnullableoptional
created_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "consent.reset",
  "params": {},
  "entity": {
    "kind": "property",
    "data": {
      "id": "string",
      "company_id": "string",
      "name": "string",
      "description": "string",
      "type": "DOMAIN",
      "status": "NEW",
      "is_setup": false,
      "is_verified": false,
      "is_watermark_disabled": false,
      "is_limited": false,
      "limited_at": "string",
      "is_subscription_active": false,
      "is_gpp_enabled": false,
      "send_details_of_dsar": false,
      "dsr_auto_open": false,
      "dsr_auto_progress": false,
      "dsr_auto_closed": false,
      "email": ["string"],
      "email_signature": "string",
      "widget_type": "V1",
      "widget_version": "string",
      "country_id": "string",
      "state_id": "string",
      "industry_id": 0,
      "sector_id": 0,
      "mspa_covered_transaction": "YES",
      "mspa_opt_out_option_mode": "NOT_APPLICABLE",
      "mspa_service_provider_mode": "NOT_APPLICABLE",
      "activated_at": "string",
      "reset_at": "string",
      "created_at": "string"
    }
  }
}

Triggered when Google Consent Mode setup succeeds.

Request bodyapplication/json
eventstringrequired
The `consent.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property record.
Show properties
kindstringenumoptional
Entity type; always `property`.
Possible values: property
dataobjectoptional
Property entity
Show properties
idstringoptional
Property ID
company_idstringoptional
Company ID
namestringoptional
Property name
descriptionstringoptional
Property description
typestringenumoptional
Property type
Possible values: DOMAIN OFFLINE
statusstringenumoptional
Property status
Possible values: NEW INVITED SCANNED ACTIVE
is_setupbooleanoptional
Whether setup is complete
is_verifiedbooleanoptional
Whether the domain is verified
is_watermark_disabledbooleanoptional
Whether the watermark is disabled
is_limitedbooleanoptional
Whether the property is limited
limited_atstringnullableoptional
is_subscription_activebooleanoptional
Whether the subscription is active
is_gpp_enabledbooleanoptional
Whether IAB GPP is enabled
send_details_of_dsarbooleanoptional
Whether DSAR details are emailed
dsr_auto_openbooleanoptional
dsr_auto_progressbooleanoptional
dsr_auto_closedbooleanoptional
emailstring[]optional
Notification email addresses
email_signaturestringoptional
widget_typestringenumoptional
Possible values: V1 V2
widget_versionstringoptional
country_idstringnullableoptional
Country code
state_idstringnullableoptional
State/region code
industry_idintegernullableoptional
sector_idintegernullableoptional
mspa_covered_transactionstringenumoptional
Possible values: YES NO
mspa_opt_out_option_modestringenumoptional
Possible values: NOT_APPLICABLE YES NO
mspa_service_provider_modestringenumoptional
Possible values: NOT_APPLICABLE YES NO
activated_atstringnullableoptional
reset_atstringnullableoptional
created_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "consent.reset",
  "params": {},
  "entity": {
    "kind": "property",
    "data": {
      "id": "string",
      "company_id": "string",
      "name": "string",
      "description": "string",
      "type": "DOMAIN",
      "status": "NEW",
      "is_setup": false,
      "is_verified": false,
      "is_watermark_disabled": false,
      "is_limited": false,
      "limited_at": "string",
      "is_subscription_active": false,
      "is_gpp_enabled": false,
      "send_details_of_dsar": false,
      "dsr_auto_open": false,
      "dsr_auto_progress": false,
      "dsr_auto_closed": false,
      "email": ["string"],
      "email_signature": "string",
      "widget_type": "V1",
      "widget_version": "string",
      "country_id": "string",
      "state_id": "string",
      "industry_id": 0,
      "sector_id": 0,
      "mspa_covered_transaction": "YES",
      "mspa_opt_out_option_mode": "NOT_APPLICABLE",
      "mspa_service_provider_mode": "NOT_APPLICABLE",
      "activated_at": "string",
      "reset_at": "string",
      "created_at": "string"
    }
  }
}

Triggered when Google Consent Mode setup fails.

Request bodyapplication/json
eventstringrequired
The `consent.*` event name.
paramsobjectrequired
Event-specific context; may be empty.
entityobjectoptional
The related property record.
Show properties
kindstringenumoptional
Entity type; always `property`.
Possible values: property
dataobjectoptional
Property entity
Show properties
idstringoptional
Property ID
company_idstringoptional
Company ID
namestringoptional
Property name
descriptionstringoptional
Property description
typestringenumoptional
Property type
Possible values: DOMAIN OFFLINE
statusstringenumoptional
Property status
Possible values: NEW INVITED SCANNED ACTIVE
is_setupbooleanoptional
Whether setup is complete
is_verifiedbooleanoptional
Whether the domain is verified
is_watermark_disabledbooleanoptional
Whether the watermark is disabled
is_limitedbooleanoptional
Whether the property is limited
limited_atstringnullableoptional
is_subscription_activebooleanoptional
Whether the subscription is active
is_gpp_enabledbooleanoptional
Whether IAB GPP is enabled
send_details_of_dsarbooleanoptional
Whether DSAR details are emailed
dsr_auto_openbooleanoptional
dsr_auto_progressbooleanoptional
dsr_auto_closedbooleanoptional
emailstring[]optional
Notification email addresses
email_signaturestringoptional
widget_typestringenumoptional
Possible values: V1 V2
widget_versionstringoptional
country_idstringnullableoptional
Country code
state_idstringnullableoptional
State/region code
industry_idintegernullableoptional
sector_idintegernullableoptional
mspa_covered_transactionstringenumoptional
Possible values: YES NO
mspa_opt_out_option_modestringenumoptional
Possible values: NOT_APPLICABLE YES NO
mspa_service_provider_modestringenumoptional
Possible values: NOT_APPLICABLE YES NO
activated_atstringnullableoptional
reset_atstringnullableoptional
created_atstringoptional

Response 200: Acknowledged

Payload

{
  "event": "consent.reset",
  "params": {},
  "entity": {
    "kind": "property",
    "data": {
      "id": "string",
      "company_id": "string",
      "name": "string",
      "description": "string",
      "type": "DOMAIN",
      "status": "NEW",
      "is_setup": false,
      "is_verified": false,
      "is_watermark_disabled": false,
      "is_limited": false,
      "limited_at": "string",
      "is_subscription_active": false,
      "is_gpp_enabled": false,
      "send_details_of_dsar": false,
      "dsr_auto_open": false,
      "dsr_auto_progress": false,
      "dsr_auto_closed": false,
      "email": ["string"],
      "email_signature": "string",
      "widget_type": "V1",
      "widget_version": "string",
      "country_id": "string",
      "state_id": "string",
      "industry_id": 0,
      "sector_id": 0,
      "mspa_covered_transaction": "YES",
      "mspa_opt_out_option_mode": "NOT_APPLICABLE",
      "mspa_service_provider_mode": "NOT_APPLICABLE",
      "activated_at": "string",
      "reset_at": "string",
      "created_at": "string"
    }
  }
}

© 2026 ClymTermsPrivacy policyCookie policy