Skip to main content
PUT
/
v3
/
profiles
/
{profile}
/
attributes
/
comms
Edit Profile Attributes (Comms)
curl --request PUT \
  --url https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/attributes/comms \
  --header 'Content-Type: application/json' \
  --data '
{
  "email_optout": true,
  "push_optout": true,
  "sms_optout": true,
  "post_optout": true,
  "phone_optout": true,
  "email_bounced": true,
  "push_bounced": true,
  "sms_bounced": true,
  "post_bounced": true,
  "phone_bounced": true,
  "sms_promo": true,
  "push_promo": true,
  "email_promo": true,
  "post_promo": true,
  "phone_promo": true,
  "email_discover": true,
  "email_benefits": true,
  "email_reminders": true,
  "email_account": true,
  "email_bookings": true,
  "email_feedback": true,
  "email_location": true,
  "email_service": true,
  "sms_discover": true,
  "sms_benefits": true,
  "sms_reminders": true,
  "sms_account": true,
  "sms_bookings": true,
  "sms_feedback": true,
  "sms_location": true,
  "sms_service": true,
  "push_discover": true,
  "push_benefits": true,
  "push_reminders": true,
  "push_account": true,
  "push_bookings": true,
  "push_feedback": true,
  "push_location": true,
  "push_service": true,
  "phone_discover": true,
  "phone_benefits": true,
  "phone_reminders": true,
  "phone_account": true,
  "phone_bookings": true,
  "phone_feedback": true,
  "phone_location": true,
  "phone_service": true,
  "post_discover": true,
  "post_benefits": true,
  "post_reminders": true,
  "post_account": true,
  "post_bookings": true,
  "post_feedback": true,
  "post_location": true,
  "post_service": true,
  "email_consent_updated_at": "2023-11-07T05:31:56Z",
  "sms_consent_updated_at": "2023-11-07T05:31:56Z",
  "terms_accepted_at": "2023-11-07T05:31:56Z",
  "terms_accepted_version": "<string>"
}
'
import requests

url = "https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/attributes/comms"

payload = {
    "email_optout": True,
    "push_optout": True,
    "sms_optout": True,
    "post_optout": True,
    "phone_optout": True,
    "email_bounced": True,
    "push_bounced": True,
    "sms_bounced": True,
    "post_bounced": True,
    "phone_bounced": True,
    "sms_promo": True,
    "push_promo": True,
    "email_promo": True,
    "post_promo": True,
    "phone_promo": True,
    "email_discover": True,
    "email_benefits": True,
    "email_reminders": True,
    "email_account": True,
    "email_bookings": True,
    "email_feedback": True,
    "email_location": True,
    "email_service": True,
    "sms_discover": True,
    "sms_benefits": True,
    "sms_reminders": True,
    "sms_account": True,
    "sms_bookings": True,
    "sms_feedback": True,
    "sms_location": True,
    "sms_service": True,
    "push_discover": True,
    "push_benefits": True,
    "push_reminders": True,
    "push_account": True,
    "push_bookings": True,
    "push_feedback": True,
    "push_location": True,
    "push_service": True,
    "phone_discover": True,
    "phone_benefits": True,
    "phone_reminders": True,
    "phone_account": True,
    "phone_bookings": True,
    "phone_feedback": True,
    "phone_location": True,
    "phone_service": True,
    "post_discover": True,
    "post_benefits": True,
    "post_reminders": True,
    "post_account": True,
    "post_bookings": True,
    "post_feedback": True,
    "post_location": True,
    "post_service": True,
    "email_consent_updated_at": "2023-11-07T05:31:56Z",
    "sms_consent_updated_at": "2023-11-07T05:31:56Z",
    "terms_accepted_at": "2023-11-07T05:31:56Z",
    "terms_accepted_version": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    email_optout: true,
    push_optout: true,
    sms_optout: true,
    post_optout: true,
    phone_optout: true,
    email_bounced: true,
    push_bounced: true,
    sms_bounced: true,
    post_bounced: true,
    phone_bounced: true,
    sms_promo: true,
    push_promo: true,
    email_promo: true,
    post_promo: true,
    phone_promo: true,
    email_discover: true,
    email_benefits: true,
    email_reminders: true,
    email_account: true,
    email_bookings: true,
    email_feedback: true,
    email_location: true,
    email_service: true,
    sms_discover: true,
    sms_benefits: true,
    sms_reminders: true,
    sms_account: true,
    sms_bookings: true,
    sms_feedback: true,
    sms_location: true,
    sms_service: true,
    push_discover: true,
    push_benefits: true,
    push_reminders: true,
    push_account: true,
    push_bookings: true,
    push_feedback: true,
    push_location: true,
    push_service: true,
    phone_discover: true,
    phone_benefits: true,
    phone_reminders: true,
    phone_account: true,
    phone_bookings: true,
    phone_feedback: true,
    phone_location: true,
    phone_service: true,
    post_discover: true,
    post_benefits: true,
    post_reminders: true,
    post_account: true,
    post_bookings: true,
    post_feedback: true,
    post_location: true,
    post_service: true,
    email_consent_updated_at: '2023-11-07T05:31:56Z',
    sms_consent_updated_at: '2023-11-07T05:31:56Z',
    terms_accepted_at: '2023-11-07T05:31:56Z',
    terms_accepted_version: '<string>'
  })
};

fetch('https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/attributes/comms', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/attributes/comms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'email_optout' => true,
    'push_optout' => true,
    'sms_optout' => true,
    'post_optout' => true,
    'phone_optout' => true,
    'email_bounced' => true,
    'push_bounced' => true,
    'sms_bounced' => true,
    'post_bounced' => true,
    'phone_bounced' => true,
    'sms_promo' => true,
    'push_promo' => true,
    'email_promo' => true,
    'post_promo' => true,
    'phone_promo' => true,
    'email_discover' => true,
    'email_benefits' => true,
    'email_reminders' => true,
    'email_account' => true,
    'email_bookings' => true,
    'email_feedback' => true,
    'email_location' => true,
    'email_service' => true,
    'sms_discover' => true,
    'sms_benefits' => true,
    'sms_reminders' => true,
    'sms_account' => true,
    'sms_bookings' => true,
    'sms_feedback' => true,
    'sms_location' => true,
    'sms_service' => true,
    'push_discover' => true,
    'push_benefits' => true,
    'push_reminders' => true,
    'push_account' => true,
    'push_bookings' => true,
    'push_feedback' => true,
    'push_location' => true,
    'push_service' => true,
    'phone_discover' => true,
    'phone_benefits' => true,
    'phone_reminders' => true,
    'phone_account' => true,
    'phone_bookings' => true,
    'phone_feedback' => true,
    'phone_location' => true,
    'phone_service' => true,
    'post_discover' => true,
    'post_benefits' => true,
    'post_reminders' => true,
    'post_account' => true,
    'post_bookings' => true,
    'post_feedback' => true,
    'post_location' => true,
    'post_service' => true,
    'email_consent_updated_at' => '2023-11-07T05:31:56Z',
    'sms_consent_updated_at' => '2023-11-07T05:31:56Z',
    'terms_accepted_at' => '2023-11-07T05:31:56Z',
    'terms_accepted_version' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/attributes/comms"

	payload := strings.NewReader("{\n  \"email_optout\": true,\n  \"push_optout\": true,\n  \"sms_optout\": true,\n  \"post_optout\": true,\n  \"phone_optout\": true,\n  \"email_bounced\": true,\n  \"push_bounced\": true,\n  \"sms_bounced\": true,\n  \"post_bounced\": true,\n  \"phone_bounced\": true,\n  \"sms_promo\": true,\n  \"push_promo\": true,\n  \"email_promo\": true,\n  \"post_promo\": true,\n  \"phone_promo\": true,\n  \"email_discover\": true,\n  \"email_benefits\": true,\n  \"email_reminders\": true,\n  \"email_account\": true,\n  \"email_bookings\": true,\n  \"email_feedback\": true,\n  \"email_location\": true,\n  \"email_service\": true,\n  \"sms_discover\": true,\n  \"sms_benefits\": true,\n  \"sms_reminders\": true,\n  \"sms_account\": true,\n  \"sms_bookings\": true,\n  \"sms_feedback\": true,\n  \"sms_location\": true,\n  \"sms_service\": true,\n  \"push_discover\": true,\n  \"push_benefits\": true,\n  \"push_reminders\": true,\n  \"push_account\": true,\n  \"push_bookings\": true,\n  \"push_feedback\": true,\n  \"push_location\": true,\n  \"push_service\": true,\n  \"phone_discover\": true,\n  \"phone_benefits\": true,\n  \"phone_reminders\": true,\n  \"phone_account\": true,\n  \"phone_bookings\": true,\n  \"phone_feedback\": true,\n  \"phone_location\": true,\n  \"phone_service\": true,\n  \"post_discover\": true,\n  \"post_benefits\": true,\n  \"post_reminders\": true,\n  \"post_account\": true,\n  \"post_bookings\": true,\n  \"post_feedback\": true,\n  \"post_location\": true,\n  \"post_service\": true,\n  \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"terms_accepted_at\": \"2023-11-07T05:31:56Z\",\n  \"terms_accepted_version\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/attributes/comms")
  .header("Content-Type", "application/json")
  .body("{\n  \"email_optout\": true,\n  \"push_optout\": true,\n  \"sms_optout\": true,\n  \"post_optout\": true,\n  \"phone_optout\": true,\n  \"email_bounced\": true,\n  \"push_bounced\": true,\n  \"sms_bounced\": true,\n  \"post_bounced\": true,\n  \"phone_bounced\": true,\n  \"sms_promo\": true,\n  \"push_promo\": true,\n  \"email_promo\": true,\n  \"post_promo\": true,\n  \"phone_promo\": true,\n  \"email_discover\": true,\n  \"email_benefits\": true,\n  \"email_reminders\": true,\n  \"email_account\": true,\n  \"email_bookings\": true,\n  \"email_feedback\": true,\n  \"email_location\": true,\n  \"email_service\": true,\n  \"sms_discover\": true,\n  \"sms_benefits\": true,\n  \"sms_reminders\": true,\n  \"sms_account\": true,\n  \"sms_bookings\": true,\n  \"sms_feedback\": true,\n  \"sms_location\": true,\n  \"sms_service\": true,\n  \"push_discover\": true,\n  \"push_benefits\": true,\n  \"push_reminders\": true,\n  \"push_account\": true,\n  \"push_bookings\": true,\n  \"push_feedback\": true,\n  \"push_location\": true,\n  \"push_service\": true,\n  \"phone_discover\": true,\n  \"phone_benefits\": true,\n  \"phone_reminders\": true,\n  \"phone_account\": true,\n  \"phone_bookings\": true,\n  \"phone_feedback\": true,\n  \"phone_location\": true,\n  \"phone_service\": true,\n  \"post_discover\": true,\n  \"post_benefits\": true,\n  \"post_reminders\": true,\n  \"post_account\": true,\n  \"post_bookings\": true,\n  \"post_feedback\": true,\n  \"post_location\": true,\n  \"post_service\": true,\n  \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"terms_accepted_at\": \"2023-11-07T05:31:56Z\",\n  \"terms_accepted_version\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/attributes/comms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email_optout\": true,\n  \"push_optout\": true,\n  \"sms_optout\": true,\n  \"post_optout\": true,\n  \"phone_optout\": true,\n  \"email_bounced\": true,\n  \"push_bounced\": true,\n  \"sms_bounced\": true,\n  \"post_bounced\": true,\n  \"phone_bounced\": true,\n  \"sms_promo\": true,\n  \"push_promo\": true,\n  \"email_promo\": true,\n  \"post_promo\": true,\n  \"phone_promo\": true,\n  \"email_discover\": true,\n  \"email_benefits\": true,\n  \"email_reminders\": true,\n  \"email_account\": true,\n  \"email_bookings\": true,\n  \"email_feedback\": true,\n  \"email_location\": true,\n  \"email_service\": true,\n  \"sms_discover\": true,\n  \"sms_benefits\": true,\n  \"sms_reminders\": true,\n  \"sms_account\": true,\n  \"sms_bookings\": true,\n  \"sms_feedback\": true,\n  \"sms_location\": true,\n  \"sms_service\": true,\n  \"push_discover\": true,\n  \"push_benefits\": true,\n  \"push_reminders\": true,\n  \"push_account\": true,\n  \"push_bookings\": true,\n  \"push_feedback\": true,\n  \"push_location\": true,\n  \"push_service\": true,\n  \"phone_discover\": true,\n  \"phone_benefits\": true,\n  \"phone_reminders\": true,\n  \"phone_account\": true,\n  \"phone_bookings\": true,\n  \"phone_feedback\": true,\n  \"phone_location\": true,\n  \"phone_service\": true,\n  \"post_discover\": true,\n  \"post_benefits\": true,\n  \"post_reminders\": true,\n  \"post_account\": true,\n  \"post_bookings\": true,\n  \"post_feedback\": true,\n  \"post_location\": true,\n  \"post_service\": true,\n  \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"terms_accepted_at\": \"2023-11-07T05:31:56Z\",\n  \"terms_accepted_version\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": [
    "<unknown>"
  ]
}
{
  "message": "<string>"
}
{
  "message": "<string>"
}
{
  "message": "<string>"
}
{
  "message": "<string>",
  "errors": {}
}

Path Parameters

​
profile
string<uuid>
required

The profile ID

Body

application/json
​
email_optout
boolean | null
​
push_optout
boolean | null
​
sms_optout
boolean | null
​
post_optout
boolean | null
​
phone_optout
boolean | null
​
email_bounced
boolean
​
push_bounced
boolean
​
sms_bounced
boolean
​
post_bounced
boolean
​
phone_bounced
boolean
​
sms_promo
boolean
​
push_promo
boolean
​
email_promo
boolean
​
post_promo
boolean
​
phone_promo
boolean
​
email_discover
boolean
​
email_benefits
boolean
​
email_reminders
boolean
​
email_account
boolean
​
email_bookings
boolean
​
email_feedback
boolean
​
email_location
boolean
​
email_service
boolean
​
sms_discover
boolean
​
sms_benefits
boolean
​
sms_reminders
boolean
​
sms_account
boolean
​
sms_bookings
boolean
​
sms_feedback
boolean
​
sms_location
boolean
​
sms_service
boolean
​
push_discover
boolean
​
push_benefits
boolean
​
push_reminders
boolean
​
push_account
boolean
​
push_bookings
boolean
​
push_feedback
boolean
​
push_location
boolean
​
push_service
boolean
​
phone_discover
boolean
​
phone_benefits
boolean
​
phone_reminders
boolean
​
phone_account
boolean
​
phone_bookings
boolean
​
phone_feedback
boolean
​
phone_location
boolean
​
phone_service
boolean
​
post_discover
boolean
​
post_benefits
boolean
​
post_reminders
boolean
​
post_account
boolean
​
post_bookings
boolean
​
post_feedback
boolean
​
post_location
boolean
​
post_service
boolean
​
email_verification
enum<string>
Available options:
not_sent,
sent,
delivered,
undelivered,
failed,
verified
​
sms_verification
enum<string>
Available options:
not_sent,
sent,
delivered,
undelivered,
failed,
verified
​
post_verification
enum<string>
Available options:
not_sent,
sent,
delivered,
undelivered,
failed,
verified
​
phone_verification
enum<string>
Available options:
not_sent,
sent,
delivered,
undelivered,
failed,
verified
​
email_consent_updated_at
string<date-time> | null
​
sms_consent_updated_at
string<date-time> | null
​
terms_accepted_at
string<date-time> | null
​
terms_accepted_version
string | null

Response

ProfileCommsAttribute

​
data
any[]
required