marketings
Creates, updates, deletes, gets or lists a marketings resource.
Overview​
| Name | marketings |
| Type | Resource |
| Id | ovh.me.marketings |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
call | object | Details for call marketing communication |
deny_all | boolean | Stop all marketing communication (wire: denyAll) |
deny_until | string (date-time) | Stop marketing communication until this date (wire: denyUntil) |
email | object | Details for email marketing communication |
sms | object | Details for sms marketing communication |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | Retrieve user marketing consent details | ||
update | update | Update user marketing consent |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
SELECT examples​
- get
Retrieve user marketing consent details
SELECT
call,
deny_all,
deny_until,
email,
sms
FROM ovh.me.marketings
;
UPDATE examples​
- update
Update user marketing consent
UPDATE ovh.me.marketings
SET
call = '{{ call }}',
deny_all = {{ deny_all }},
deny_until = '{{ deny_until }}',
email = '{{ email }}',
sms = '{{ sms }}'
WHERE
RETURNING
call,
deny_all,
deny_until,
email,
sms;