/ai/proposals

GET

/ai/proposals

const url = 'https://example.com/api/v1/ai/proposals?state=pending&limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/ai/proposals?state=pending&limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Query Parameters

state

string

Allowed values: pending applied rejected expired failed

limit

integer

default: 50 >= 1 <= 200

Responses

200

Default Response

application/json

Array<object>

object

required

string

conversationId

required

string

tool

required

string

Allowed values: listDomains getDeliveryLog explainBounce checkDns getReputation getAlerts getLicenseState getMailbox getQueue proposeRestoreSending proposeRotateDkimKey proposeResolveAlert

title

required

string

summary

required

string

targetKind

required

string

Allowed values: mailbox domain alert

targetId

required

string

targetLabel

required

string

change

required

object

key

additional properties

precondition

required

object

key

additional properties

state

required

string

Allowed values: pending applied rejected expired failed

expiresAt

required

string

appliedAt

required

Any of:

string
null

string

detail

required

Any of:

string
null

string

createdAt

required

string

Example

[
  {
    "tool": "listDomains",
    "targetKind": "mailbox",
    "state": "pending"
  }
]