Unsubscribe Contact

unsubscribe Contact.

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.

Handles the contact.

post

Authorizations

Bearer

HTTPRequired

JWT Bearer Authorization

Path parameters

contactIdstringRequired

Id of the user (contact) to unsubscribe.

channelstringRequired

Delivery channel to unsubscribe from: Email, Sms, or Push.

versionstring · nullableRequired

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

Body

multipart/form-dataapplication/json

UnsubscribeContactRequest

reasonstring · nullableOptional

Optional suppression reason name explaining why consent was revoked.

projectIdstringRequired

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

envstring · nullableOptional

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.

cultureCodestring · nullableOptional

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

timeZoneIdstring · nullableOptional

TimeZone

correlationIdstring · nullableOptional

CorrelationId for each request

Responses

200

OK

application/json

post/{version}/membership/users/{contactId}/marketing-state/{channel}/unsubscribe

HTTPcURLJavaScriptPython

POST /{version}/membership/users/{contactId}/marketing-state/{channel}/unsubscribe HTTP/1.1
Host: api.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 158

{
  "reason": "text",
  "projectId": "text",
  "env": "text",
  "resolvedEnv": {
    "value": "text",
    "isProd": true
  },
  "cultureCode": "text",
  "timeZoneId": "text",
  "correlationId": "text"
}

multipart/form-dataapplication/json

200

OK

{
  "responseStatus": {
    "isSuccess": true
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Membership → Users.

Use it from code

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