Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get agent settings

Hosted-agent settings. BillionSend runs no agent of its own, so an inbox never has one.

GET/inboxes/{inbox_id}/agent
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
inbox_idstringrequired

The inbox ID or its email address, such as support@example.com

Responses
200

No hosted agent

objectstringrequired
Allowed:inbox_agent
instructionsnullrequired
tonenullrequired
actionsstring[]required
max items 0
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/inboxes/string/agent' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "inbox_agent",
  "instructions": null,
  "tone": null,
  "actions": []
}

Was this page helpful?