GUgupshup
Onboard

Update agent settings

Partial update. An empty body is a no-op that returns the current settings. never_say_phrases replaces the whole list; send [] to clear it. Setting rollout.enabled to true fails with 400 Cannot enable Meta Business Agent until the business has a payment method in the Billing Hub, unless ai_audience is ALLOWLISTED_ONLY.

put/partner/app/{appId}/bizai/agent_config/settings

Request

  • Base URL
    https://partner.gupshup.io
  • URL
    https://partner.gupshup.io/partner/app/{appId}/bizai/agent_config/settings
  • Auth
    API key in header Authorization

Query parameters

agent_idstring

Meta resource id.

Example:pfbid0GNkExampleExampleExample

Agent id from onboarding. Accepted but currently not applied as a filter.

Request body

ai_audience'ALLOWLISTED_ONLY' | 'EVERYONE'

Who the agent answers. ALLOWLISTED_ONLY limits it to the allowlist and needs no payment method.

never_say_phrasesstring[]

Response

Settings applied. Returns a single settings object, not an array.

agent_idstring

Meta resource id.

channel'email' | 'instagram' | 'line' | 'messenger' | 'sms' | 'tiktok' | 'unknown' | 'webchat' | 'whatsapp'
ai_audience'ALLOWLISTED_ONLY' | 'EVERYONE'

Who the agent answers. ALLOWLISTED_ONLY limits it to the allowlist and needs no payment method.

never_say_phrasesstring[]

Example response

{
  "agent_id": "pfbid0GNkExampleExampleExample"
}

Changes

No recorded changes to this operation across all 1 revision of this API.