Update slack boost

Update an existing slack boost. Only include fields you want to change. Set copy to null to clear the custom message.

PATCH/slack-boosts/{id}

Authorization

AuthorizationBearer token · headerrequired

API key authentication. Generate an API key from your workspace settings.

Path parameters

idstring<uuid>required

The unique identifier of the slack boost to update

Request body

application/json

copystring | null

Custom message in the Slack notification, or null to clear

slackWebhookIdstring<uuid>

The ID of the Slack webhook (channel) to send notifications to

Responses

200

Slack boost updated

slackBoostSlackBoost

A slack boost sends a Slack notification when its post publishes

Show properties

idstring<uuid>

copystring | null

Optional custom message in the Slack notification

isAutoCreatedboolean

True when the boost was added automatically via channel auto-boost

postIdstring<uuid>

slackWebhookSlackWebhookSummary

Slack channel (webhook) targeted by a slack boost

Show properties

idstring<uuid>

channelNamestring | null

teamNamestring | null

createdAtstring<date-time>

updatedAtstring<date-time>

400

Bad Request - Invalid input parameters

codestring

messagestring

dataobject

Show properties

errorsobject

401

Unauthorized - Missing or invalid API key

codestring

messagestring

404

Not Found - Resource does not exist

codestring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

idpath*The unique identifier of the slack boost to update

Bodyapplication/json

copystringCustom message in the Slack notification, or null to clearslackWebhookIdstringThe ID of the Slack webhook (channel) to send notifications to

Request

curl -X PATCH 'https://app.tryordinal.com/api/v1/slack-boosts/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "copy": "Updated: please engage with this week'\''s spotlight post."
}'

const response = await fetch("https://app.tryordinal.com/api/v1/slack-boosts/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"copy\": \"Updated: please engage with this week's spotlight post.\"\n}"
});

import requests

response = requests.patch(
    "https://app.tryordinal.com/api/v1/slack-boosts/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"copy\": \"Updated: please engage with this week's spotlight post.\"\n}",
)

Response

{
  "slackBoost": {
    "id": "550e8400-e29b-41d4-a716-446655440910",
    "copy": "Updated: please engage with this week's spotlight post.",
    "isAutoCreated": false,
    "postId": "550e8400-e29b-41d4-a716-446655440300",
    "slackWebhook": {
      "id": "550e8400-e29b-41d4-a716-446655440920",
      "channelName": "marketing-boost",
      "teamName": "Acme Corp"
    },
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T11:15:00.000Z"
  }
}

{
  "code": "BAD_REQUEST",
  "message": "Bad Request",
  "data": {
    "errors": {
      "publishAt": [
        "Invalid date format"
      ],
      "status": [
        "Invalid enum value"
      ]
    }
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid or unauthorized API key"
}

{
  "code": "NOT_FOUND",
  "message": "Post not found or does not belong to this workspace"
}