Update User Full Preference - SuprSend, Notification infrastructure for Product teams

PATCH

user

{distinct_id}

preference

Update User Full Preference

curl --request PATCH \
  --url https://hub.suprsend.com/v1/user/{distinct_id}/preference/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel_preferences": [
    {
      "channel": "email",
      "is_restricted": false
    }
  ],
  "categories": [
    {
      "category": "_category_slug_",
      "preference": "opt_in",
      "opt_out_channels": [],
      "opt_in_channels": []
    }
  ]
}
'

{
  "sections": [
    {
      "name": null,
      "slug": null,
      "subcategories": [
        {
          "name": "Promotion de remboursement",
          "category": "refund-promotion",
          "description": "mises à jour",
          "original_preference": null,
          "preference": "opt_in",
          "is_editable": false,
          "channels": [
            {
              "channel": "email",
              "preference": "opt_in",
              "is_editable": false
            },
            {
              "channel": "inbox",
              "preference": "opt_in",
              "is_editable": false
            }
          ]
        }
      ]
    }
  ],
  "channel_preferences": [
    {
      "channel": "email",
      "is_restricted": false
    },
    {
      "channel": "inbox",
      "is_restricted": false
    }
  ]
}

Authorizations

Authorization

string

header

required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

distinct_id

string

required

distinct_id of the user whose preferences should be updated

Query Parameters

tenant_id

string

to update user preferences for a particular tenant

Body

application/json

channel_preferences

object[]

Use this to update channel level user preferences. Set is_restricted - true if the channel is opted_out by the user. This will only send critical notifications to the user which can't be opted out

Show child attributes

Response

200

sections

object[]

Show child attributes

channel_preferences

object[]

Show child attributes

Category and Channel within CategoryAPI to update user preferences for a specific notification category.

⌘I

Update User Full Preference

curl --request PATCH \
  --url https://hub.suprsend.com/v1/user/{distinct_id}/preference/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel_preferences": [
    {
      "channel": "email",
      "is_restricted": false
    }
  ],
  "categories": [
    {
      "category": "_category_slug_",
      "preference": "opt_in",
      "opt_out_channels": [],
      "opt_in_channels": []
    }
  ]
}
'

{
  "sections": [
    {
      "name": null,
      "slug": null,
      "subcategories": [
        {
          "name": "Promotion de remboursement",
          "category": "refund-promotion",
          "description": "mises à jour",
          "original_preference": null,
          "preference": "opt_in",
          "is_editable": false,
          "channels": [
            {
              "channel": "email",
              "preference": "opt_in",
              "is_editable": false
            },
            {
              "channel": "inbox",
              "preference": "opt_in",
              "is_editable": false
            }
          ]
        }
      ]
    }
  ],
  "channel_preferences": [
    {
      "channel": "email",
      "is_restricted": false
    },
    {
      "channel": "inbox",
      "is_restricted": false
    }
  ]
}