Get communication preferences

GET

/users/{uid}/communication-preferences

const url = 'https://apisandbox.puurk.com/users/example/communication-preferences';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://apisandbox.puurk.com/users/example/communication-preferences \
  --header 'Authorization: Bearer <token>'

Returns communication preferences for a user

Authorizations

service_token

Parameters

Path Parameters

uid

required

string

User ID

Responses

200

Successful operation

application/json

object

activity

Activity notification preferences

Array<object>

object

oid

Organization ID

string

email

Activity types for email notifications

Array<string>

Allowed values: offer_accepted offer_declined offer_paid_in_full offer_shared offer_viewed contract_signed contract_fulfilled contract_cancelled payment_succeeded payment_declined payment_refunded payment_returned payment_reminder payout_initiated

sms

Activity types for SMS notifications

Array<string>

push

Activity types for push notifications

Array<string>

Example

{
  "activity": [
    {
      "email": [
        "offer_accepted"
      ],
      "sms": [
        "offer_accepted"
      ],
      "push": [
        "offer_accepted"
      ]
    }
  ]
}

401

Unauthorized

404

User not found