GUgupshup
Onboard

Get agent settings

Returns a one-element array holding the settings object. agent_id is accepted but currently ignored: an unknown id returns the same row as no filter.

get/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.

Response

Current settings.

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.