Docs
API Referencesdks@platform/sdk-messaging

@platform/sdk-messaging

Typed TypeScript client for services/messaging. The page is generated from the SDK package source plus its generated OpenAPI types.

Installation

npm install @platform/sdk-messaging

You’ll also need the shared auth/client helpers:

npm install @platform/hosts @platform/sdk

Quick start

import { LoopClient } from "@platform/sdk";
import { platformHost, SERVICE_NAMES } from "@platform/hosts";
import { createMessagingClient } from "@platform/sdk-messaging";
 
const loop = new LoopClient({
  clientId: process.env.LOOP_CLIENT_ID!,
  clientSecret: process.env.LOOP_CLIENT_SECRET!,
  redirectUri: "https://your-app.example.com/auth/loop/callback",
});
 
const messaging = createMessagingClient({
  baseUrl: platformHost({ service: SERVICE_NAMES.MESSAGING }),
  accessToken: tokens.access_token,
});

Use the convenience helpers below when the SDK exposes them, or call the typed endpoint methods directly with GET / POST / PATCH / DELETE.

Convenience helpers

This SDK does not add convenience helpers beyond the typed endpoint calls below.

Endpoint calls

GET /readyz

Underlying REST endpoint: GET /readyz

Parameters

None

Return type

Promise<{
  data?: paths["/readyz"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.GET("/readyz");

GET /v1/messaging/campaigns

Underlying REST endpoint: GET /v1/messaging/campaigns

Parameters

  • query: paths["/v1/messaging/campaigns"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/messaging/campaigns"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.GET("/v1/messaging/campaigns", {
  params: {
    query: {
      /* paths["/v1/messaging/campaigns"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/messaging/campaigns

Underlying REST endpoint: POST /v1/messaging/campaigns

Parameters

  • body?: paths["/v1/messaging/campaigns"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/campaigns"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/campaigns", {
  body: {
    /* paths["/v1/messaging/campaigns"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/messaging/campaigns/{id}

Underlying REST endpoint: GET /v1/messaging/campaigns/\{id\}

Parameters

  • path: paths["/v1/messaging/campaigns/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/messaging/campaigns/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.GET("/v1/messaging/campaigns/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/messaging/campaigns/{id}/cancel

Underlying REST endpoint: POST /v1/messaging/campaigns/\{id\}/cancel

Parameters

  • path: paths["/v1/messaging/campaigns/{id}/cancel"]["post"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/messaging/campaigns/{id}/cancel"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/campaigns/{id}/cancel", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/messaging/campaigns/{id}/publish

Underlying REST endpoint: POST /v1/messaging/campaigns/\{id\}/publish

Parameters

  • path: paths["/v1/messaging/campaigns/{id}/publish"]["post"]["parameters"]["path"]
  • body?: paths["/v1/messaging/campaigns/{id}/publish"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/campaigns/{id}/publish"]["post"]["responses"]["202"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/campaigns/{id}/publish", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/messaging/campaigns/{id}/publish"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/messaging/campaigns/{id}/schedule

Underlying REST endpoint: POST /v1/messaging/campaigns/\{id\}/schedule

Parameters

  • path: paths["/v1/messaging/campaigns/{id}/schedule"]["post"]["parameters"]["path"]
  • body?: paths["/v1/messaging/campaigns/{id}/schedule"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/campaigns/{id}/schedule"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/campaigns/{id}/schedule", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/messaging/campaigns/{id}/schedule"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/messaging/campaigns/{id}/steps

Underlying REST endpoint: POST /v1/messaging/campaigns/\{id\}/steps

Parameters

  • path: paths["/v1/messaging/campaigns/{id}/steps"]["post"]["parameters"]["path"]
  • body?: paths["/v1/messaging/campaigns/{id}/steps"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/campaigns/{id}/steps"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/campaigns/{id}/steps", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/messaging/campaigns/{id}/steps"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/messaging/consent

Underlying REST endpoint: POST /v1/messaging/consent

Parameters

  • body?: paths["/v1/messaging/consent"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/consent"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/consent", {
  body: {
    /* paths["/v1/messaging/consent"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/messaging/consent/check

Underlying REST endpoint: POST /v1/messaging/consent/check

Parameters

  • body?: paths["/v1/messaging/consent/check"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/consent/check"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/consent/check", {
  body: {
    /* paths["/v1/messaging/consent/check"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/messaging/segments

Underlying REST endpoint: GET /v1/messaging/segments

Parameters

  • query: paths["/v1/messaging/segments"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/messaging/segments"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.GET("/v1/messaging/segments", {
  params: {
    query: {
      /* paths["/v1/messaging/segments"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/messaging/segments

Underlying REST endpoint: POST /v1/messaging/segments

Parameters

  • body?: paths["/v1/messaging/segments"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/segments"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/segments", {
  body: {
    /* paths["/v1/messaging/segments"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/messaging/segments/{id}

Underlying REST endpoint: GET /v1/messaging/segments/\{id\}

Parameters

  • path: paths["/v1/messaging/segments/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/messaging/segments/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.GET("/v1/messaging/segments/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

PUT /v1/messaging/segments/{id}/predicate

Underlying REST endpoint: PUT /v1/messaging/segments/\{id\}/predicate

Parameters

  • path: paths["/v1/messaging/segments/{id}/predicate"]["put"]["parameters"]["path"]
  • body?: paths["/v1/messaging/segments/{id}/predicate"]["put"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/segments/{id}/predicate"]["put"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.PUT("/v1/messaging/segments/{id}/predicate", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/messaging/segments/{id}/predicate"]["put"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/messaging/segments/{id}/preview

Underlying REST endpoint: POST /v1/messaging/segments/\{id\}/preview

Parameters

  • path: paths["/v1/messaging/segments/{id}/preview"]["post"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/messaging/segments/{id}/preview"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/segments/{id}/preview", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/messaging/templates

Underlying REST endpoint: GET /v1/messaging/templates

Parameters

  • query: paths["/v1/messaging/templates"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/messaging/templates"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.GET("/v1/messaging/templates", {
  params: {
    query: {
      /* paths["/v1/messaging/templates"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/messaging/templates

Underlying REST endpoint: POST /v1/messaging/templates

Parameters

  • body?: paths["/v1/messaging/templates"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/templates"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/templates", {
  body: {
    /* paths["/v1/messaging/templates"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/messaging/templates/{id}/render

Underlying REST endpoint: POST /v1/messaging/templates/\{id\}/render

Parameters

  • path: paths["/v1/messaging/templates/{id}/render"]["post"]["parameters"]["path"]
  • body?: paths["/v1/messaging/templates/{id}/render"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/templates/{id}/render"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/templates/{id}/render", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/messaging/templates/{id}/render"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/messaging/templates/{id}/versions

Underlying REST endpoint: GET /v1/messaging/templates/\{id\}/versions

Parameters

  • path: paths["/v1/messaging/templates/{id}/versions"]["get"]["parameters"]["path"]
  • query?: paths["/v1/messaging/templates/{id}/versions"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/messaging/templates/{id}/versions"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.GET("/v1/messaging/templates/{id}/versions", {
  params: {
    path: {
      id: "<id>",
    },
    query: {
      /* paths["/v1/messaging/templates/{id}/versions"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/messaging/templates/{id}/versions

Underlying REST endpoint: POST /v1/messaging/templates/\{id\}/versions

Parameters

  • path: paths["/v1/messaging/templates/{id}/versions"]["post"]["parameters"]["path"]
  • body?: paths["/v1/messaging/templates/{id}/versions"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/messaging/templates/{id}/versions"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await messaging.POST("/v1/messaging/templates/{id}/versions", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/messaging/templates/{id}/versions"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

Related

@platform/sdk-membership@platform/sdk-patient-graph