API_KEY
braze_api_key
Developer setup
No fields declared in this snapshot.
User connection
- REST Endpointfull · stringRequired
- REST API Keygeneric_api_key · stringRequired
BRAZE
Braze is a customer engagement platform for managing user data, messaging, campaigns, analytics, catalogs, templates, and workspace automation.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
119
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 91–119 of 119 actions
BRAZE_REPLACE_CATALOG_ITEMS
Asynchronously replace or create up to 50 Braze catalog items by id. Requires the immutable catalogs.replace_items API-key permission and shares a 16,000 requests/minute asynchronous item limit. Catalog storage limits can reject the request. A 202 response is acceptance only, with no documented job or terminal result.
Untrusted display-only summary
BRAZE_REPLACE_MEDIA_LIBRARY_ASSET_FILE
HIGH IMPACT: request replacement of the file associated with one exact Braze media-library asset ID using a public HTTP(S) URL. The existing asset ID and hosted URL are preserved only when Braze confirms success. The replacement extension must exactly match. Replacement supports images, SVGs, documents, fonts, contact…
Untrusted display-only summary
BRAZE_SEND_CAMPAIGN_TRIGGER
HIGH IMPACT: immediately request an API-triggered campaign send. Provide up to 50 recipients, optionally intersected with a Connected Audience. Audience-only targeting requires broadcast=true; broadcast cannot include individual recipients. An accepted send cannot be retracted. Recipient attributes can update a profil…
Untrusted display-only summary
BRAZE_SEND_CANVAS_TRIGGER
HIGH IMPACT: immediately request entry into an API-triggered Canvas. Provide up to 50 recipients, optionally intersected with a Connected Audience. Audience-only targeting requires broadcast=true; broadcast cannot include individual recipients. Accepted entry cannot be retracted. Recipient attributes can update a prof…
Untrusted display-only summary
BRAZE_SEND_MESSAGES
HIGH IMPACT: immediately request API-only messages to existing Braze users. Individual targets are limited to 50 combined external IDs and aliases; without individuals you must explicitly set broadcast=true with a segment or Connected Audience. An accepted send cannot be retracted. Requires messages.send. Channel payl…
Untrusted display-only summary
BRAZE_SEND_TRANSACTIONAL_CAMPAIGN
HIGH IMPACT: send one immediate transactional email from a Braze Transactional Email campaign to exactly one external-ID or alias recipient; an accepted send cannot be retracted. Recipient attributes can update a profile or create a missing external-ID profile before sending. This is a select-package paid capability r…
Untrusted display-only summary
BRAZE_SET_EMAIL_SUBSCRIPTION_STATUS
HIGH IMPACT: set the global email subscription state for one to 50 exact addresses, including addresses not yet attached to a profile. Global unsubscribed overrides every subscription group. Success is rejected unless Braze explicitly returns message=success. Default rate limit: 250,000 requests/hour.
Untrusted display-only summary
BRAZE_SET_PRIMARY_SDK_AUTHENTICATION_KEY
HIGH IMPACT SECURITY OPERATION: make one exact existing SDK Authentication key the primary key for one exact app. This changes which key new SDK clients should use. Success is rejected unless the returned key list marks that exact key primary. Default rate limit: 250,000 requests/hour.
Untrusted display-only summary
BRAZE_SET_SUBSCRIPTION_GROUP_STATUS
HIGH IMPACT: batch subscribe or unsubscribe up to 50 users in one exact group. Email-only or phone-only calls can affect every profile sharing the identifier; external IDs may be combined with one channel identifier. Orphaned channel states persist up to 30 days. LINE group use requires approval from the Braze custome…
Untrusted display-only summary
BRAZE_SET_SUBSCRIPTION_GROUP_STATUSES
HIGH IMPACT: batch subscribe or unsubscribe users across multiple groups. Each group update must use exactly one of external_ids, emails, or E.164 phones; only external IDs may span email and SMS groups in one call. Orphaned channel states persist up to 30 days. LINE group use requires approval from the Braze customer…
Untrusted display-only summary
BRAZE_START_LIVE_ACTIVITY
HIGH IMPACT: remotely request an iOS Live Activity start for exactly one target mode: up to 50 external users, one Connected Audience, or one segment. Requires Swift SDK push-to-start setup, matching ActivityAttributes and ContentState shapes, payload-size compliance, and messages.live_activity.start. HTTP 201 means B…
Untrusted display-only summary
BRAZE_TRACK_USERS
Asynchronously ingest Braze attributes, custom events, or purchases, up to 75 combined objects per portable request. Attribute objects can create or update profiles; event and purchase objects are durably recorded. Requires users.track. Each custom attribute consumes a data point; rate limits vary by contract (3,000 r…
Untrusted display-only summary
BRAZE_TRIGGER_CLOUD_DATA_INGESTION_SYNC
HIGH IMPACT: enqueue a sync for an existing Cloud Data Ingestion integration. This can ingest durable user or non-user data and consume data points. A 202 success only confirms acceptance, not completion; poll sync statuses. Requires CDI entitlement and is limited to 20 requests/minute.
Untrusted display-only summary
BRAZE_UPDATE_CAMPAIGN_TRANSLATIONS
Submit a durable update request with translation-tag string values for one campaign message locale. This does not publish, launch, send, or prove delivery; read back the translations to verify resulting stored content. A launched campaign must first have its message saved as a draft. Requires campaigns.translations.up…
Untrusted display-only summary
BRAZE_UPDATE_CAMPAIGN_TRIGGER_SCHEDULE
HIGH IMPACT: durably replace the full schedule for a previously scheduled API-triggered campaign. Omitted local or optimal-time flags do not carry forward. Near send time changes are best-effort, and a local-time schedule cannot be updated after its time passed in any zone. Requires campaigns.trigger.schedule.update;…
Untrusted display-only summary
BRAZE_UPDATE_CANVAS_TRANSLATIONS
Submit a durable update request with translation-tag string values for one Canvas step message locale. This does not publish, launch, send, or prove delivery; read back the translations to verify resulting stored content. A launched Canvas must first have its message saved as a draft. Requires canvas.translations.upda…
Untrusted display-only summary
BRAZE_UPDATE_CANVAS_TRIGGER_SCHEDULE
HIGH IMPACT: durably replace the full schedule for a previously scheduled API-triggered Canvas. Omitted local or optimal-time flags do not carry forward, and near-send changes are best-effort. Requires canvas.trigger.schedule.update; the change persists until updated, deleted, or entered, and acceptance does not prove…
Untrusted display-only summary
BRAZE_UPDATE_CATALOG_ITEM
Synchronously patch one existing Braze catalog item. Requires the immutable catalogs.update_item API-key permission and shares a 50 requests/minute synchronous item limit. The item ID belongs only in the path.
Untrusted display-only summary
BRAZE_UPDATE_CATALOG_ITEMS
Asynchronously patch up to 50 existing Braze catalog items. Requires the immutable catalogs.update_items API-key permission and shares a 16,000 requests/minute asynchronous item limit. A 202 response confirms acceptance only and supplies no documented job ID, per-item result, or completion proof.
Untrusted display-only summary
BRAZE_UPDATE_CONTENT_BLOCK
Persist changes to one existing Braze Content Block by API identifier. This updates stored content only; it does not send or deliver a message.
Untrusted display-only summary
BRAZE_UPDATE_CONTENT_BLOCK_TRANSLATIONS
Submit a durable update request with translation-tag string values for one Content Block locale. This does not publish, send, or prove delivery in a message using the block; read back the translations to verify resulting stored content. Requires content_blocks.translations.update and has a 250,000 requests/minute limi…
Untrusted display-only summary
BRAZE_UPDATE_EMAIL_TEMPLATE
Persist one or more changes to an existing Braze email template by API identifier. This updates stored content only; it does not send or deliver email.
Untrusted display-only summary
BRAZE_UPDATE_EMAIL_TEMPLATE_TRANSLATIONS
Submit a durable update request with translation-tag string values for one email template locale. This does not send, schedule, publish, or prove email delivery; read back the translations to verify resulting stored content. Requires templates.translations.update and has a 250,000 requests/minute limit.
Untrusted display-only summary
BRAZE_UPDATE_LIVE_ACTIVITY
Update an SDK-registered iOS Live Activity without ending it. Requires matching ContentState shape, payload-size compliance, and messages.live_activity.update. An optional dismissal_date updates when the activity is removed from the UI without ending it. Use END_LIVE_ACTIVITY for the irreversible terminal operation. H…
Untrusted display-only summary
BRAZE_UPDATE_MESSAGE_SCHEDULE
HIGH IMPACT: durably update the schedule, documented channel message objects, or both for an API-only scheduled message. The replacement persists until updated, deleted, or sent. Requires messages.schedule.update; acceptance confirms neither dispatch nor delivery.
Untrusted display-only summary
BRAZE_UPDATE_PREFERENCE_CENTER
HIGH IMPACT: durably update a Braze preference center's required page HTML and confirmation HTML, plus an optional title, state, or options configuration. Omitted title, state, and options are not sent. The immutable name is not accepted. Limited to 10 requests/minute per workspace.
Untrusted display-only summary
BRAZE_UPDATE_PUSH_CREDENTIALS
HIGH IMPACT: replace one app's push credentials for exactly one platform. A bad credential can stop push delivery. Braze documents no endpoint-specific rate limit or public plan gate; the workspace must expose the Apps credential API.
Untrusted display-only summary
BRAZE_UPDATE_USER_ALIASES
Asynchronously request renaming of up to 50 existing Braze aliases. Requires users.alias.update and shares a 20,000 requests/minute rate limit. A success response confirms acceptance only, not completion; update ordering is not guaranteed, and a nonmatching old alias may produce no change.
Untrusted display-only summary
BRAZE_UPDATE_WEBHOOK_TEMPLATE_TRANSLATIONS
Submit a durable update request with translation-tag string values for one webhook template locale. This does not invoke, publish, deliver, or prove delivery of a webhook; read back the translations to verify resulting stored content. Requires templates.translations.update and webhook template translations enabled by…
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.