TSGGLOBAL Support sign in
Skip to page content
Browse TNID API docs

TNID API documentation Company B2C subscriptions Create B2C subscription request

Create B2C subscription request

On this page

GraphQL endpoint: /company

Sends a subscription request to a user asking for their consent to receive communications of the given type (EMAIL, SMS, VOICE). The request stays PENDING until the user responds. If the user accepts, a B2C subscription is created. If they reject, the request is marked as rejected and no subscription is created.

Query

mutation (
  $invitedUserId: ID!
  $type: B2cSubscriptionType!
  $subscriptionTopicIds: [ID!]
) {
  createB2cSubscriptionRequest (
    invitedUserId: $invitedUserId
    type: $type
    subscriptionTopicIds: $subscriptionTopicIds
  ) {
    id
    status
    type
    insertedAt
    updatedAt
    respondedAt
    company {
      id
    }
    user {
      id
    }
    invitedUser {
      id
    }
  }
}

Variables

{
  "invitedUserId": "00000000-0000-4000-8000-000000000003",
  "type": "EMAIL"
}

Response

{
  "data": {
    "createB2cSubscriptionRequest": {
      "company": {
        "id": "00000000-0000-4000-8000-000000000001"
      },
      "id": "00000000-0000-4000-8000-000000000002",
      "insertedAt": "2026-01-15T09:00:00.000000",
      "invitedUser": {
        "id": "00000000-0000-4000-8000-000000000003"
      },
      "respondedAt": null,
      "status": "PENDING",
      "type": "EMAIL",
      "updatedAt": "2026-01-15T09:00:00.000000",
      "user": null
    }
  }
}