Update current user compliance settings

curl --request PUT \
  --url https://api.leadping.ai/users/compliance \
  --header 'Content-Type: application/json' \
  --data '
{
  "compliance": {
    "acceptedTerms": true,
    "acceptedToSubscription": true,
    "acceptedSms": true,
    "acceptedBaa": true,
    "acceptedEmail": true,
    "trustedFormCertificates": [
      {
        "id": "<string>",
        "url": "<string>",
        "source": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "source": "<string>"
}
'

import requests

url = "https://api.leadping.ai/users/compliance"

payload = {
    "compliance": {
        "acceptedTerms": True,
        "acceptedToSubscription": True,
        "acceptedSms": True,
        "acceptedBaa": True,
        "acceptedEmail": True,
        "trustedFormCertificates": [
            {
                "id": "<string>",
                "url": "<string>",
                "source": "<string>",
                "createdAt": "2023-11-07T05:31:56Z"
            }
        ]
    },
    "source": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/users/compliance");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"compliance\": {\n    \"acceptedTerms\": true,\n    \"acceptedToSubscription\": true,\n    \"acceptedSms\": true,\n    \"acceptedBaa\": true,\n    \"acceptedEmail\": true,\n    \"trustedFormCertificates\": [\n      {\n        \"id\": \"<string>\",\n        \"url\": \"<string>\",\n        \"source\": \"<string>\",\n        \"createdAt\": \"2023-11-07T05:31:56Z\"\n      }\n    ]\n  },\n  \"source\": \"<string>\"\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

HttpResponse<String> response = Unirest.put("https://api.leadping.ai/users/compliance")
  .header("Content-Type", "application/json")
  .body("{\n  \"compliance\": {\n    \"acceptedTerms\": true,\n    \"acceptedToSubscription\": true,\n    \"acceptedSms\": true,\n    \"acceptedBaa\": true,\n    \"acceptedEmail\": true,\n    \"trustedFormCertificates\": [\n      {\n        \"id\": \"<string>\",\n        \"url\": \"<string>\",\n        \"source\": \"<string>\",\n        \"createdAt\": \"2023-11-07T05:31:56Z\"\n      }\n    ]\n  },\n  \"source\": \"<string>\"\n}")
  .asString();

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    compliance: {
      acceptedTerms: true,
      acceptedToSubscription: true,
      acceptedSms: true,
      acceptedBaa: true,
      acceptedEmail: true,
      trustedFormCertificates: [
        {
          id: '<string>',
          url: '<string>',
          source: '<string>',
          createdAt: '2023-11-07T05:31:56Z'
        }
      ]
    },
    source: '<string>'
  })
};

fetch('https://api.leadping.ai/users/compliance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.leadping.ai/users/compliance"

	payload := strings.NewReader("{\n  \"compliance\": {\n    \"acceptedTerms\": true,\n    \"acceptedToSubscription\": true,\n    \"acceptedSms\": true,\n    \"acceptedBaa\": true,\n    \"acceptedEmail\": true,\n    \"trustedFormCertificates\": [\n      {\n        \"id\": \"<string>\",\n        \"url\": \"<string>\",\n        \"source\": \"<string>\",\n        \"createdAt\": \"2023-11-07T05:31:56Z\"\n      }\n    ]\n  },\n  \"source\": \"<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))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/users/compliance",
  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([
    'compliance' => [
        'acceptedTerms' => true,
        'acceptedToSubscription' => true,
        'acceptedSms' => true,
        'acceptedBaa' => true,
        'acceptedEmail' => true,
        'trustedFormCertificates' => [
                [
                                'id' => '<string>',
                                'url' => '<string>',
                                'source' => '<string>',
                                'createdAt' => '2023-11-07T05:31:56Z'
                ]
        ]
    ],
    'source' => '<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;
}

{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "timeZoneId": "<string>",
  "billingState": {
    "hasStripeCustomer": true,
    "hasPaymentMethod": true,
    "phoneNumberQuantity": "<string>",
    "businessUserQuantity": "<string>",
    "businessUserAssignedQuantity": "<string>",
    "billingPlanChangeEffectiveAt": "2023-11-07T05:31:56Z",
    "planRenewalAt": "2023-11-07T05:31:56Z",
    "cancelAt": "2023-11-07T05:31:56Z",
    "dunning": {
      "stage": "<string>",
      "paymentFailedAt": "2023-11-07T05:31:56Z",
      "lastFailedInvoiceStatus": "<string>",
      "retryAttemptCount": "<string>",
      "nextRetryAt": "2023-11-07T05:31:56Z",
      "gracePeriodEndsAt": "2023-11-07T05:31:56Z",
      "outboundRestrictedAt": "2023-11-07T05:31:56Z",
      "outboundSuspendedAt": "2023-11-07T05:31:56Z",
      "finalCancellationAt": "2023-11-07T05:31:56Z",
      "lastUpdatedAt": "2023-11-07T05:31:56Z"
    },
    "lastSubscriptionEventAt": "2023-11-07T05:31:56Z",
    "lastPaymentMethodEventAt": "2023-11-07T05:31:56Z"
  },
  "roles": "<array>",
  "identities": [
    {
      "issuer": "<string>",
      "issuerAssignedId": "<string>",
      "signInType": "<string>"
    }
  ],
  "currentBusiness": {
    "id": "<string>",
    "name": "<string>"
  },
  "compliance": {
    "acceptedTerms": true,
    "acceptedToSubscription": true,
    "acceptedSms": true,
    "acceptedBaa": true,
    "acceptedEmail": true,
    "trustedFormCertificates": [
      {
        "id": "<string>",
        "url": "<string>",
        "source": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "notificationPreferences": {
    "smsConsentOptedIn": true,
    "smsConsentUpdatedAt": "2023-11-07T05:31:56Z",
    "smsConsentTrustedFormCertificate": {
      "id": "<string>",
      "url": "<string>",
      "source": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "paymentFailedEnabled": true,
    "paymentFailedSmsEnabled": true,
    "lowWalletBalanceEnabled": true,
    "lowWalletBalanceEmailEnabled": true,
    "lowWalletBalanceSmsEnabled": true,
    "tenDlcStatusEnabled": true,
    "newLeadEnabled": true,
    "newLeadEmailEnabled": true,
    "newLeadSmsEnabled": true,
    "missedCallEnabled": true,
    "missedCallEmailEnabled": true,
    "missedCallSmsEnabled": true,
    "unreadSmsEnabled": true,
    "unreadSmsEmailEnabled": true,
    "unreadSmsSmsEnabled": true,
    "automationFailedEnabled": true,
    "automationFailedEmailEnabled": true,
    "automationFailedSmsEnabled": true,
    "billingEmailEnabled": true,
    "billingSmsEnabled": true,
    "subscriptionRenewingEnabled": true,
    "subscriptionRenewingEmailEnabled": true,
    "subscriptionRenewingSmsEnabled": true,
    "usageLimitHitEnabled": true
  },
  "mobileDevicePreferences": [
    {
      "device": {
        "id": "<string>",
        "name": "<string>"
      },
      "inboundPhoneCallsEnabled": true,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "lastLoggedInAt": "2023-11-07T05:31:56Z",
  "personalDataDeletionRequestedAt": "2023-11-07T05:31:56Z",
  "personalDataDeletedAt": "2023-11-07T05:31:56Z",
  "personalDataDeletionStatus": "<string>",
  "personalDataDeletionReason": "<string>",
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

PUT

users

compliance

Update current user compliance settings

curl --request PUT \
  --url https://api.leadping.ai/users/compliance \
  --header 'Content-Type: application/json' \
  --data '
{
  "compliance": {
    "acceptedTerms": true,
    "acceptedToSubscription": true,
    "acceptedSms": true,
    "acceptedBaa": true,
    "acceptedEmail": true,
    "trustedFormCertificates": [
      {
        "id": "<string>",
        "url": "<string>",
        "source": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "source": "<string>"
}
'

import requests

url = "https://api.leadping.ai/users/compliance"

payload = {
    "compliance": {
        "acceptedTerms": True,
        "acceptedToSubscription": True,
        "acceptedSms": True,
        "acceptedBaa": True,
        "acceptedEmail": True,
        "trustedFormCertificates": [
            {
                "id": "<string>",
                "url": "<string>",
                "source": "<string>",
                "createdAt": "2023-11-07T05:31:56Z"
            }
        ]
    },
    "source": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/users/compliance");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"compliance\": {\n    \"acceptedTerms\": true,\n    \"acceptedToSubscription\": true,\n    \"acceptedSms\": true,\n    \"acceptedBaa\": true,\n    \"acceptedEmail\": true,\n    \"trustedFormCertificates\": [\n      {\n        \"id\": \"<string>\",\n        \"url\": \"<string>\",\n        \"source\": \"<string>\",\n        \"createdAt\": \"2023-11-07T05:31:56Z\"\n      }\n    ]\n  },\n  \"source\": \"<string>\"\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

HttpResponse<String> response = Unirest.put("https://api.leadping.ai/users/compliance")
  .header("Content-Type", "application/json")
  .body("{\n  \"compliance\": {\n    \"acceptedTerms\": true,\n    \"acceptedToSubscription\": true,\n    \"acceptedSms\": true,\n    \"acceptedBaa\": true,\n    \"acceptedEmail\": true,\n    \"trustedFormCertificates\": [\n      {\n        \"id\": \"<string>\",\n        \"url\": \"<string>\",\n        \"source\": \"<string>\",\n        \"createdAt\": \"2023-11-07T05:31:56Z\"\n      }\n    ]\n  },\n  \"source\": \"<string>\"\n}")
  .asString();

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    compliance: {
      acceptedTerms: true,
      acceptedToSubscription: true,
      acceptedSms: true,
      acceptedBaa: true,
      acceptedEmail: true,
      trustedFormCertificates: [
        {
          id: '<string>',
          url: '<string>',
          source: '<string>',
          createdAt: '2023-11-07T05:31:56Z'
        }
      ]
    },
    source: '<string>'
  })
};

fetch('https://api.leadping.ai/users/compliance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.leadping.ai/users/compliance"

	payload := strings.NewReader("{\n  \"compliance\": {\n    \"acceptedTerms\": true,\n    \"acceptedToSubscription\": true,\n    \"acceptedSms\": true,\n    \"acceptedBaa\": true,\n    \"acceptedEmail\": true,\n    \"trustedFormCertificates\": [\n      {\n        \"id\": \"<string>\",\n        \"url\": \"<string>\",\n        \"source\": \"<string>\",\n        \"createdAt\": \"2023-11-07T05:31:56Z\"\n      }\n    ]\n  },\n  \"source\": \"<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))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/users/compliance",
  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([
    'compliance' => [
        'acceptedTerms' => true,
        'acceptedToSubscription' => true,
        'acceptedSms' => true,
        'acceptedBaa' => true,
        'acceptedEmail' => true,
        'trustedFormCertificates' => [
                [
                                'id' => '<string>',
                                'url' => '<string>',
                                'source' => '<string>',
                                'createdAt' => '2023-11-07T05:31:56Z'
                ]
        ]
    ],
    'source' => '<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;
}

{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "timeZoneId": "<string>",
  "billingState": {
    "hasStripeCustomer": true,
    "hasPaymentMethod": true,
    "phoneNumberQuantity": "<string>",
    "businessUserQuantity": "<string>",
    "businessUserAssignedQuantity": "<string>",
    "billingPlanChangeEffectiveAt": "2023-11-07T05:31:56Z",
    "planRenewalAt": "2023-11-07T05:31:56Z",
    "cancelAt": "2023-11-07T05:31:56Z",
    "dunning": {
      "stage": "<string>",
      "paymentFailedAt": "2023-11-07T05:31:56Z",
      "lastFailedInvoiceStatus": "<string>",
      "retryAttemptCount": "<string>",
      "nextRetryAt": "2023-11-07T05:31:56Z",
      "gracePeriodEndsAt": "2023-11-07T05:31:56Z",
      "outboundRestrictedAt": "2023-11-07T05:31:56Z",
      "outboundSuspendedAt": "2023-11-07T05:31:56Z",
      "finalCancellationAt": "2023-11-07T05:31:56Z",
      "lastUpdatedAt": "2023-11-07T05:31:56Z"
    },
    "lastSubscriptionEventAt": "2023-11-07T05:31:56Z",
    "lastPaymentMethodEventAt": "2023-11-07T05:31:56Z"
  },
  "roles": "<array>",
  "identities": [
    {
      "issuer": "<string>",
      "issuerAssignedId": "<string>",
      "signInType": "<string>"
    }
  ],
  "currentBusiness": {
    "id": "<string>",
    "name": "<string>"
  },
  "compliance": {
    "acceptedTerms": true,
    "acceptedToSubscription": true,
    "acceptedSms": true,
    "acceptedBaa": true,
    "acceptedEmail": true,
    "trustedFormCertificates": [
      {
        "id": "<string>",
        "url": "<string>",
        "source": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "notificationPreferences": {
    "smsConsentOptedIn": true,
    "smsConsentUpdatedAt": "2023-11-07T05:31:56Z",
    "smsConsentTrustedFormCertificate": {
      "id": "<string>",
      "url": "<string>",
      "source": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "paymentFailedEnabled": true,
    "paymentFailedSmsEnabled": true,
    "lowWalletBalanceEnabled": true,
    "lowWalletBalanceEmailEnabled": true,
    "lowWalletBalanceSmsEnabled": true,
    "tenDlcStatusEnabled": true,
    "newLeadEnabled": true,
    "newLeadEmailEnabled": true,
    "newLeadSmsEnabled": true,
    "missedCallEnabled": true,
    "missedCallEmailEnabled": true,
    "missedCallSmsEnabled": true,
    "unreadSmsEnabled": true,
    "unreadSmsEmailEnabled": true,
    "unreadSmsSmsEnabled": true,
    "automationFailedEnabled": true,
    "automationFailedEmailEnabled": true,
    "automationFailedSmsEnabled": true,
    "billingEmailEnabled": true,
    "billingSmsEnabled": true,
    "subscriptionRenewingEnabled": true,
    "subscriptionRenewingEmailEnabled": true,
    "subscriptionRenewingSmsEnabled": true,
    "usageLimitHitEnabled": true
  },
  "mobileDevicePreferences": [
    {
      "device": {
        "id": "<string>",
        "name": "<string>"
      },
      "inboundPhoneCallsEnabled": true,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "lastLoggedInAt": "2023-11-07T05:31:56Z",
  "personalDataDeletionRequestedAt": "2023-11-07T05:31:56Z",
  "personalDataDeletedAt": "2023-11-07T05:31:56Z",
  "personalDataDeletionStatus": "<string>",
  "personalDataDeletionReason": "<string>",
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

Body

The compliance update request payload for the operation.

Request payload for compliance update.

compliance

object | null

The compliance value for this compliance update.

Show child attributes

source

string | null

The source value for this compliance update.

Response

Returns the user response.

API response containing user data returned to callers.

string

The email address associated with this user.

firstName

string | null

The first name value for this user.

lastName

string | null

The date and time for the last name value on this user.

phone

string | null

The phone number associated with this user.

timeZoneId

string | null

IANA time zone identifier used when displaying dates and times for this user.

billingPlan

enum<string> | null

Defines the supported Billing Plan values.

Available options:

Annual,

Monthly

subscriptionStatus

enum<string> | null

Defines the supported Subscription Status values.

Available options:

Pending,

Active,

Overdue,

Canceled

billingState

object | null

Customer-safe billing state for the user's currently selected business.

Show child attributes

roles

array | null

The roles included with this user.

identities

object[] | null

The identities included with this user.

Show child attributes

currentBusiness

object | null

The current business value for this user.

Show child attributes

compliance

object | null

The compliance value for this user.

Show child attributes

notificationPreferences

object | null

The notification preferences value for this user.

Show child attributes

mobileDevicePreferences

object[] | null

The Leadping mobile device preferences for this user.

Show child attributes

lastLoggedInAt

string<date-time> | null

The date and time when this user last completed the Leadping sign-in flow.

personalDataDeletionRequestedAt

string<date-time> | null

The date and time for the personal data deletion requested at value on this user.

personalDataDeletedAt

string<date-time> | null

The date and time for the personal data deleted at value on this user.

personalDataDeletionStatus

string | null

The current personal data deletion status for this user.

personalDataDeletionReason

string | null

The human-readable personal data deletion reason explaining this user.

name

string

The display name for the entity.

string

The unique identifier for the entity.

createdAt

string<date-time>

The date and time when the entity was created.

modifiedAt

string<date-time> | null

The date and time when the entity was last modified, if applicable.

Change the current user's billing plan Initiates a phone call.

Analytics

Automations

Contact

Conversations

Dispositions

Feedback

Leads

LeadStatuses

Notifications

OutboundDelivery

Sources

Suppressions

Tags

Users

Calls

PhoneNumbers

Sms

Telephony

UserDataExports

CallEvents

Events

SmsEvents

Businesses

PaymentMethods

Transactions

Usage

Wallets

Update current user compliance settings

Body

Response