Set Contact Tag Subscription

set Contact Tag Subscription.

A contact (user) is a person in your project's membership directory, with one or more linked logins (identities). Membership manages their profile, identities, roles, and lifecycle.

Sets the contact tag subscription.

put

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

ContactIdstring · nullableRequired

Id of the user (contact) to update.

CommChannelstring · nullableRequired

Communication channel type: Marketing or Transactional.

Channelstring · nullableRequired

Delivery channel: Email, Sms, or Push.

Tagstring · nullableRequired

The tag name; must already exist for the communication channel.

VersionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Body

SetContactTagSubscriptionRequest

correlationIdstringOptional

CorrelationId for each request

cultureCodestringOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstringOptional

TimeZone

versionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

envstringOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

subscribedbooleanOptional

True to subscribe (unblock) the tag, false to block it.

Responses

200

Success

application/json

EmptyResponse

put/{version}/membership/users/{contactId}/marketing-state/{commChannel}/{channel}/tags/{tag}

PUT /{version}/membership/users/{contactId}/marketing-state/{commChannel}/{channel}/tags/{tag} HTTP/1.1
Host: api.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 132

{
  "subscribed": true,
  "projectId": "text",
  "env": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "correlationId": "text",
  "version": "text"
}

200

Success

{
  "success": {
    "responseStatus": {
      "isSuccess": true
    }
  },
  "responseStatus": {
    "isSuccess": true
  }
}

In Cloud

Manage this visually in Cloud — see Membership → Users.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Set Contact Tag Subscription in the SDK reference, with examples in every language.