Grant Contact Consent

grant Contact Consent.

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 consent.

post

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

ContactIdstring · nullableRequired

Id of the user (contact) to grant consent for.

Channelstring · nullableRequired

Delivery channel to grant consent on: Email, Sms, or Push.

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

GrantContactConsentRequest

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.

lawfulBasisstring · nullableOptional

Lawful basis for the consent, e.g. Consent. Defaults to Consent.

sourcestring · nullableOptional

Source of the consent, e.g. UserOptIn. Defaults to UserOptIn.

evidenceRefstring · nullableOptional

Optional free-text reference to evidence of consent (e.g. a form submission id).

Responses

200

Success

application/json

EmptyResponse

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

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

{
  "lawfulBasis": "text",
  "source": "text",
  "evidenceRef": "text",
  "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 Grant Contact Consent in the SDK reference, with examples in every language.