> ## Documentation Index
> Fetch the complete documentation index at: https://www.courier.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Publish Preferences Page

> Publishes the workspace preference page, snapshotting every preference and topic, and returns the page id and a preview URL.



## OpenAPI

````yaml /openapi-specs/openapi.documented.yml post /preferences/publish
openapi: 3.0.1
info:
  title: Courier
  description: The Courier REST API for sending and managing notifications across channels.
  version: 0.0.1
servers:
  - url: https://api.courier.com
    description: Production
security: []
tags:
  - name: Send
    description: >-
      Send a message to one or more recipients — users, lists, audiences, or
      tenants — across every channel you have configured.
  - name: Templates
    description: >-
      Create, update, version, publish, and localize notification templates and
      their content.
  - name: Brands
    description: >-
      Manage the logos, colors, and layout that give the templates you send a
      consistent look.
  - name: Routing Strategies
    description: >-
      Define reusable channel routing and failover strategies, and see which
      templates use them.
  - name: Journeys
    description: >-
      Build, version, publish, invoke, and cancel multi-step notification
      workflows, along with the templates scoped to them.
  - name: Broadcasts
    description: >-
      Create a one-off send to a list or audience, author its content, then send
      it immediately or schedule it for later.
  - name: User Profiles
    description: >-
      Store the contact information Courier delivers to for each user — email,
      phone number, push tokens, and any custom data you send to.
  - name: Tenants
    description: >-
      Manage tenants — the organizations, teams, or accounts your users belong
      to — along with their users and default preferences.
  - name: Audiences
    description: >-
      Define filter-based groups whose membership Courier recalculates as user
      profiles change.
  - name: Lists
    description: >-
      Manage static groups of users that you subscribe explicitly, and send to
      them by list id or list pattern.
  - name: Providers
    description: >-
      Configure the channel providers Courier delivers through, and browse the
      provider types it supports.
  - name: Preference Topics
    description: >-
      Manage the workspace catalog of subscription topics, the sections that
      group them, and publishing the preference page.
  - name: User Preferences
    description: >-
      Read and write a single user's notification preferences, per topic and per
      channel.
  - name: Messages
    description: >-
      Look up the messages Courier has accepted, inspect their delivery history
      and rendered output, and cancel, resend, or archive them.
  - name: Device Tokens
    description: >-
      Register and manage the APNS and FCM device tokens Courier delivers push
      notifications to.
  - name: Tenant Memberships
    description: >-
      Associate a user with one or more tenants, and read or remove those
      associations.
  - name: Tenant Templates
    description: >-
      Manage the templates and template versions scoped to a single tenant,
      including the ones authored in the embedded designer.
  - name: Automations
    description: >-
      Invoke a stored automation template or an ad hoc automation defined in the
      request.
  - name: Digests
    description: >-
      Inspect what has accumulated in a digest schedule and release a digest
      ahead of its next scheduled delivery.
  - name: Translations
    description: >-
      Store and retrieve the translation strings Courier uses to render
      localized template content.
  - name: Inbox
    description: Manage the messages in a user's in-app inbox.
  - name: Track Events
    description: >-
      Record an inbound event that triggers the journeys and automations mapped
      to it.
  - name: Audit Events
    description: >-
      Read the audit trail of configuration and access changes in your
      workspace.
  - name: Authentication
    description: >-
      Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences,
      and the embedded designer — can call Courier as a single user. Server-side
      requests authenticate with your workspace API key instead.
paths:
  /preferences/publish:
    post:
      tags:
        - Preference Topics
      summary: Publish Preferences Page
      description: >-
        Publishes the workspace preference page, snapshotting every preference
        and topic, and returns the page id and a preview URL.
      operationId: workspacePreferences_publish
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/IdempotencyExpiration'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishPreferencesRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishPreferencesResponse'
              examples:
                Example:
                  value:
                    page_id: page_default
                    published_at: '2024-01-15T10:30:00.000Z'
                    published_by: user_123
                    published_version: 1
                    preview_url: https://example.com
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Courier from '@trycourier/courier';


            const client = new Courier({
              apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
            });


            const publishPreferencesResponse = await
            client.workspacePreferences.publish();


            console.log(publishPreferencesResponse.page_id);
        - lang: Python
          source: >-
            import os

            from courier import Courier


            client = Courier(
                api_key=os.environ.get("COURIER_API_KEY"),  # This is the default and can be omitted
            )

            publish_preferences_response =
            client.workspace_preferences.publish()

            print(publish_preferences_response.page_id)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/trycourier/courier-go\"\n\t\"github.com/trycourier/courier-go/option\"\n)\n\nfunc main() {\n\tclient := courier.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpublishPreferencesResponse, err := client.WorkspacePreferences.Publish(context.TODO(), courier.WorkspacePreferencePublishParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", publishPreferencesResponse.PageID)\n}\n"
        - lang: Java
          source: >-
            package com.courier.example;


            import com.courier.client.CourierClient;

            import com.courier.client.okhttp.CourierOkHttpClient;

            import
            com.courier.models.workspacepreferences.PublishPreferencesResponse;

            import
            com.courier.models.workspacepreferences.WorkspacePreferencePublishParams;


            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    CourierClient client = CourierOkHttpClient.fromEnv();

                    PublishPreferencesResponse publishPreferencesResponse = client.workspacePreferences().publish();
                }
            }
        - lang: Ruby
          source: |-
            require "courier"

            courier = Courier::Client.new(api_key: "My API Key")

            publish_preferences_response = courier.workspace_preferences.publish

            puts(publish_preferences_response)
        - lang: PHP
          source: >-
            <?php


            require_once dirname(__DIR__) . '/vendor/autoload.php';


            use Courier\Client;

            use Courier\Core\Exceptions\APIException;


            $client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API
            Key');


            try {
              $publishPreferencesResponse = $client->workspacePreferences->publish(
                brandID: 'brand_id',
                description: 'description',
                heading: 'heading',
                idempotencyKey: 'order-ORD-456-user-123',
                xIdempotencyExpiration: '1785312000',
              );

              var_dump($publishPreferencesResponse);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: C#
          source: >-
            using System;

            using TryCourier;

            using TryCourier.Models.WorkspacePreferences;


            CourierClient client = new();


            WorkspacePreferencePublishParams parameters = new();


            var publishPreferencesResponse = await
            client.WorkspacePreferences.Publish(parameters);


            Console.WriteLine(publishPreferencesResponse);
        - lang: CLI
          source: |-
            courier workspace-preferences publish \
              --api-key 'My API Key'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        A unique key that makes this request idempotent. If Courier receives
        another request with the same `Idempotency-Key`, it returns the stored
        response from the first request without performing the operation again
        (including the original status code and any error). Use it to safely
        retry `POST` requests after network failures without risking duplicate
        sends. The key is scoped to this endpoint.
      schema:
        type: string
      example: order-ORD-456-user-123
    IdempotencyExpiration:
      name: x-idempotency-expiration
      in: header
      required: false
      description: >-
        How long the idempotency key remains valid, as a Unix epoch timestamp in
        seconds or an ISO 8601 date string. Only applies when `Idempotency-Key`
        is provided. If omitted, the key is retained for 25 hours; the maximum
        is 1 year.
      schema:
        type: string
      example: '1785312000'
  schemas:
    PublishPreferencesRequest:
      title: PublishPreferencesRequest
      type: object
      description: >-
        Optional page metadata to apply when publishing the workspace's
        preferences page. All fields are optional; omitted fields fall back to
        the page defaults (and the workspace default brand).
      properties:
        heading:
          type: string
          nullable: true
          description: Heading shown at the top of the hosted preferences page.
        description:
          type: string
          nullable: true
          description: Description shown under the heading on the hosted preferences page.
        brand_id:
          type: string
          nullable: true
          description: >-
            Brand for the hosted page - "default" (workspace default brand),
            "none" (no brand), or a specific brand id. Defaults to "default".
    PublishPreferencesResponse:
      title: PublishPreferencesResponse
      type: object
      description: Result of publishing the workspace's preferences page.
      properties:
        page_id:
          type: string
          description: Id of the published page snapshot.
        published_at:
          type: string
          description: ISO-8601 timestamp of the publish.
        published_by:
          type: string
          nullable: true
          description: Id of the publisher.
        published_version:
          type: number
          description: Monotonic published version (epoch milliseconds).
        preview_url:
          type: string
          nullable: true
          description: Draft-mode hosted preferences page URL for previewing.
      required:
        - page_id
        - published_at
        - published_version
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````