Skip to main content
GET
Get Meta agent settings

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

connection_id
string
required

The ID of the connection

phone_number_id
string
required

The ID of the WhatsApp phone number the Meta agent runs on

Query Parameters

agent_id
string

The agent settings to read or change. Defaults to the most recent ones.

Maximum string length: 128
page
number

Page number

take
number

Number of items to take

next
string

Next page token (Only used on special endpoints)

Response

200 - application/json
agent_id
string
required
channel
string
required
rollout
object
required
handoff
object
required
followup
object
required
ai_audience
enum<string>
required

Who the agent answers. ALLOWLISTED_ONLY is test mode: only the allowlisted numbers get replies.

Available options:
EVERYONE,
ALLOWLISTED_ONLY
never_say_phrases
string[]