Agent Inbox

App · 15 actions

Read and organize messages from your Agent Inbox and manage interactions and contacts.

Actions

ActionWhat it does
Ask a questionSend a question and return the interaction ID for its answer.
Cancel interactionCancel interaction in Agent Inbox.
Check inbox addressCheck inbox address in Agent Inbox.
Get contactGet contact in Agent Inbox.
Get conversationGet conversation in Agent Inbox.
Get default agentGet default agent in Agent Inbox.
Get inbox ownerGet the owner of this Agent Inbox account.
Get interactionGet interaction in Agent Inbox.
List contactsList contacts in Agent Inbox.
List conversationsList conversations in Agent Inbox.
Mark conversation readMark conversation read in Agent Inbox.
Reply to a conversationSend a message in an existing Agent Inbox conversation.
Request approvalSend an approval request and return the interaction ID for its outcome.
Resolve conversationResolve conversation in Agent Inbox.
Send messageSend a message to one contact in Agent Inbox.

Ask a question

Send a question and return the interaction ID for its answer.

Inputs

Contactcontact_idtextRequired
Choose a contact or enter their email address.
MessagetitletextRequired
Enter the message or question to send.
Agent identifieragent_identifiertext
Leave empty to use your default agent.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example",
      "threads": []
    }
  }
}

Cancel interaction

Cancel interaction in Agent Inbox.

Inputs

Interaction IDinteraction_idtextRequired
Interaction ID.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example"
    }
  }
}

Check inbox address

Check inbox address in Agent Inbox.

Inputs

Mailbox handlehandletext
Mailbox handle.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": {}
  }
}

Get contact

Get contact in Agent Inbox.

Inputs

Contactcontact_idtextRequired
Contact.
Agent identifieragent_identifiertext
Leave empty to use your default agent.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": {
      "email": "example",
      "firstName": "example",
      "lastName": "example",
      "subscriberId": "example"
    }
  }
}

Get conversation

Get conversation in Agent Inbox.

Inputs

Conversationconversation_idtextRequired
Conversation.
Agent identifieragent_identifiertext
Leave empty to use your default agent.
Limitlimitnumber
Limit.From 1 to 100.
Older messages cursorbeforetext
Older messages cursor.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": {
      "messages": [],
      "thread": {
        "channel": "example",
        "id": "example",
        "lastActivityAt": "example",
        "lastMessage": {
          "at": "example",
          "id": "example",
          "text": "example"
        },
        "status": "example"
      }
    }
  }
}

Get default agent

Get default agent in Agent Inbox.

Inputs

Agent identifieragent_identifiertext
Leave empty to use your default agent.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": {}
  }
}

Get inbox owner

Get the owner of this Agent Inbox account.

Inputs

None.

Outputs

dataobject
The inbox owner response.
Example output
{
  "data": {
    "data": {
      "subscriberId": "example"
    }
  }
}

Get interaction

Get interaction in Agent Inbox.

Inputs

Interaction IDinteraction_idtextRequired
Interaction ID.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example",
      "threads": []
    }
  }
}

List contacts

List contacts in Agent Inbox.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Next page cursoraftertext
Next page cursor.
Agent identifieragent_identifiertext
Leave empty to use your default agent.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": [],
    "next": "example"
  }
}

List conversations

List conversations in Agent Inbox.

Inputs

Read statusfiltertext
Read status.One of: all, unread, read.
Statusstatustext
Status.One of: all, open, resolved.
Senderssenderstext
Senders.One of: contacts, all.
Limitlimitnumber
Limit.From 1 to 100.
Next page cursoraftertext
Next page cursor.
Agent identifieragent_identifiertext
Leave empty to use your default agent.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": [],
    "next": "example"
  }
}

Mark conversation read

Mark conversation read in Agent Inbox.

Inputs

Conversationconversation_idtextRequired
Conversation.
Agent identifieragent_identifiertext
Leave empty to use your default agent.

Outputs

dataobject
The updated conversation.
Example output
{
  "data": {
    "data": {
      "channel": "example",
      "id": "example",
      "lastActivityAt": "example",
      "lastMessage": {
        "at": "example",
        "id": "example",
        "text": "example"
      },
      "status": "example"
    }
  }
}

Reply to a conversation

Send a message in an existing Agent Inbox conversation.

Inputs

Conversationconversation_idtextRequired
Choose the conversation to reply to.
MessagetitletextRequired
Enter the message or question to send.
Agent identifieragent_identifiertext
Leave empty to use your default agent.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example",
      "threads": []
    }
  }
}

Request approval

Send an approval request and return the interaction ID for its outcome.

Inputs

Contactcontact_idtextRequired
Choose a contact or enter their email address.
MessagetitletextRequired
Enter the message or question to send.
Agent identifieragent_identifiertext
Leave empty to use your default agent.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example",
      "threads": []
    }
  }
}

Resolve conversation

Resolve conversation in Agent Inbox.

Inputs

Conversationconversation_idtextRequired
Conversation.
Agent identifieragent_identifiertext
Leave empty to use your default agent.

Outputs

dataobject
The updated conversation.
Example output
{
  "data": {
    "data": {
      "channel": "example",
      "id": "example",
      "lastActivityAt": "example",
      "lastMessage": {
        "at": "example",
        "id": "example",
        "text": "example"
      },
      "status": "example"
    }
  }
}

Send message

Send a message to one contact in Agent Inbox.

Inputs

Contactcontact_idtextRequired
Choose a contact or enter their email address.
MessagetitletextRequired
Enter the message or question to send.
Agent identifieragent_identifiertext
Leave empty to use your default agent.

Outputs

dataobject
The Agent Inbox response.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example",
      "threads": []
    }
  }
}

On this page