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

> ## Agent Instructions
> Install the Courier skill before writing code: `npx skills add trycourier/courier-skills`. It carries the verified SDK shapes and the rules you cannot get wrong.
> Authenticate every request with `Authorization: Bearer <API_KEY>`. A workspace has several environments and each has its own keys, which are plain `pk_` strings with no environment prefix. Start with Test.
> Send with `client.send.message` from the Node SDK (`@trycourier/courier` v7 and later, where the client is the default import). Reference a template by its `nt_` id or its alias.
> A send accepts a bare Elemental element list, but storing content on a template requires the top-level elements wrapped in a channel element.
> To translate a template, write one locale at a time with `PUT /notifications/{id}/locales/{localeId}`, which merges into the existing translations. `PUT /notifications/{id}/content` and `PUT /notifications/{id}/elements/{elementId}` overwrite translations along with the content, so send each element's `id` and `locales` back, and first remove every `checksum` and any `locales` key that starts with an underscore.
> Templates and journeys can be built in the Courier app or created through the API. Either way they live in the workspace and are referenced by ID when you send.
> The hosted MCP server is https://mcp.courier.com. For a briefing on what Courier is and when to use it, read https://www.courier.com/llms.txt.
> Prefer the Guides tab for how-do-I questions and the Docs tab for how-does-it-behave questions. The API reference lives under /api-reference.

# Patch a Provider

> Updates part of a provider's configuration and keeps every field you omit. Settings merge into the stored settings key by key, and a setting sent as null is removed.



## OpenAPI

````yaml /openapi-specs/openapi.documented.yml patch /providers/{id}
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: Previews
    description: >-
      Render a template's email content on real email clients and read back the
      screenshots, so you can check how it looks before you send it.
  - 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: 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:
  /providers/{id}:
    patch:
      tags:
        - Providers
      summary: Patch a Provider
      description: >-
        Updates part of a provider's configuration and keeps every field you
        omit. Settings merge into the stored settings key by key, and a setting
        sent as null is removed.
      operationId: providers_patch
      parameters:
        - name: id
          in: path
          description: A unique identifier of the provider configuration to update.
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProvidersPatchRequest'
            examples:
              Example:
                summary: >-
                  Rename the configuration and change one setting, keeping the
                  others
                value:
                  title: Production SendGrid
                  settings:
                    api_key: SG.xxxxxxxx
              RemoveSetting:
                summary: Remove the rate limit and keep every other setting
                value:
                  settings:
                    rate_limit: null
              ClearAlias:
                summary: Remove the configuration's alias
                value:
                  alias: null
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Provider'
              examples:
                Example:
                  value:
                    id: pc_01kx4h2jdafq8bk9arsty8hr35
                    title: Example Name
                    provider: string
                    alias: string
                    settings: {}
                    created: 1
                    updated: 1
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
              examples:
                Example:
                  value:
                    message: Example message text
                    type: invalid_request_error
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
              examples:
                Example:
                  value:
                    message: Example message text
                    type: invalid_request_error
      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 provider = await client.providers.patch('id', {
              settings: { api_key: 'SG.xxxxxxxx' },
              title: 'Production SendGrid',
            });

            console.log(provider.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
            )
            provider = client.providers.patch(
                id="id",
                settings={
                    "api_key": "SG.xxxxxxxx"
                },
                title="Production SendGrid",
            )
            print(provider.id)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/trycourier/courier-go/v4\"\n\t\"github.com/trycourier/courier-go/v4/option\"\n)\n\nfunc main() {\n\tclient := courier.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tprovider, err := client.Providers.Patch(\n\t\tcontext.TODO(),\n\t\t\"id\",\n\t\tcourier.ProviderPatchParams{\n\t\t\tSettings: map[string]any{\n\t\t\t\t\"api_key\": \"SG.xxxxxxxx\",\n\t\t\t},\n\t\t\tTitle: courier.String(\"Production SendGrid\"),\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", provider.ID)\n}\n"
        - lang: Java
          source: |-
            package com.courier.example;

            import com.courier.client.CourierClient;
            import com.courier.client.okhttp.CourierOkHttpClient;
            import com.courier.models.providers.Provider;
            import com.courier.models.providers.ProviderPatchParams;

            public final class Main {
                private Main() {}

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

                    Provider provider = client.providers().patch("id");
                }
            }
        - lang: Ruby
          source: |-
            require "courier"

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

            provider = courier.providers.patch("id")

            puts(provider)
        - 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 {
              $provider = $client->providers->patch(
                'id',
                alias: 'alias',
                provider: 'provider',
                settings: ['api_key' => 'bar'],
                title: 'Production SendGrid',
              );

              var_dump($provider);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: C#
          source: |-
            using System;
            using TryCourier;
            using TryCourier.Models.Providers;

            CourierClient client = new();

            ProviderPatchParams parameters = new() { ID = "id" };

            var provider = await client.Providers.Patch(parameters);

            Console.WriteLine(provider);
        - lang: CLI
          source: |-
            courier providers patch \
              --api-key 'My API Key' \
              --id id
components:
  schemas:
    ProvidersPatchRequest:
      title: ProvidersPatchRequest
      type: object
      description: >-
        Request body for a partial update of a provider configuration. Every
        field is optional, and a field you omit keeps its stored value. The body
        must include at least one of `title`, `alias`, or `settings`, otherwise
        the request returns a 400. The provider type of an existing
        configuration cannot be changed.
      properties:
        provider:
          type: string
          maxLength: 128
          description: >-
            The provider key identifying the type. Optional. When sent, it must
            match the stored provider, otherwise the request returns a 400.
        title:
          type: string
          description: Updated display title.
        alias:
          type: string
          nullable: true
          description: Updated alias. Set to null to clear it.
        settings:
          type: object
          description: >-
            Provider-specific settings (snake_case keys) to merge into the
            stored settings, using JSON Merge Patch (RFC 7396). Each key you
            send replaces the stored value, a key set to null is removed, nested
            objects merge recursively, and arrays replace the stored value. Keys
            you omit keep their stored values. Set `rate_limit` to null to
            remove this configuration's send rate limit.
          additionalProperties: true
    Provider:
      title: Provider
      type: object
      description: A configured provider in the workspace.
      properties:
        id:
          type: string
          description: A unique identifier for the provider configuration.
        title:
          type: string
          description: >-
            Display title. Defaults to "Default Configuration" when not
            explicitly set.
        provider:
          type: string
          description: The provider key (e.g. "sendgrid", "twilio", "slack").
        alias:
          type: string
          description: Optional alias for this configuration.
        settings:
          type: object
          description: >-
            Provider-specific settings (snake_case keys on the wire).
            `rate_limit` is this configuration's send rate limit, `{ "rate":
            number, "period": "second" | "minute" | "hour" }`, or null for no
            limit.
          additionalProperties: true
        created:
          type: integer
          description: Unix timestamp (ms) of when the provider was created.
        updated:
          type: integer
          nullable: true
          description: Unix timestamp (ms) of when the provider was last updated.
      required:
        - id
        - title
        - provider
        - settings
        - created
    BadRequest:
      title: BadRequest
      type: object
      properties:
        type:
          type: string
          enum:
            - invalid_request_error
      required:
        - type
      allOf:
        - $ref: '#/components/schemas/BaseError'
    NotFound:
      title: NotFound
      type: object
      properties:
        type:
          type: string
          enum:
            - invalid_request_error
      required:
        - type
      allOf:
        - $ref: '#/components/schemas/BaseError'
    BaseError:
      title: BaseError
      type: object
      properties:
        message:
          type: string
          description: A message describing the error that occurred.
      required:
        - message
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````