Fetchply Docs
API reference

List email mailboxes or read mailbox setup

GET
/api/v1/agents/{id}/email

Authorization

BearerAuth read:email
AuthorizationBearer <token>

In: header

Scope: read:email

Path Parameters

id*string

Query Parameters

mailboxId?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/agents/string/email"
{
  "mailbox": {
    "id": "string",
    "chatbotId": "string",
    "domainId": "string",
    "address": "string",
    "name": "string",
    "status": "pending",
    "isDefault": true,
    "aiEnabled": true,
    "instructions": "string",
    "signature": "string",
    "toolAllowlist": [
      "string"
    ],
    "receivingVerifiedAt": "2019-08-24T14:15:22Z",
    "lastReceivedAt": "2019-08-24T14:15:22Z",
    "testSentAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "domain": {
    "id": "string",
    "domain": "string",
    "status": "string",
    "dkimTokens": [
      "string"
    ],
    "mailFromDomain": "string",
    "mailFromStatus": "string",
    "dmarcRecord": "string",
    "verifiedAt": "2019-08-24T14:15:22Z",
    "checkedAt": "2019-08-24T14:15:22Z"
  },
  "forwardingAddress": "string",
  "dns": [
    {
      "type": "string",
      "name": "string",
      "value": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

Send a message to an agent POST

Send a visitor message to an agent and receive its reply as JSON. Each delivered message uses one message credit from the account plan. Conversations appear in the dashboard Inbox under the API channel. Requires the `write:chat` permission.

Manage an email mailbox POST

Connect an owned business address, check DNS, test forwarding/sending, activate, update settings, disconnect or reconnect. Setup tests send real emails. Automatic replies default off.