v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Inboxes

Create teammate private inbox

Create a private inbox for a teammate.

Required scope: inboxes:write

post/teammates/{teammate_id}/private_inboxes

Path parameters

teammate_idstring required

The teammate ID

Request body

namestring required

The name of the inbox

custom_fieldsCustomFieldParameter

An object whose key is the name property defined for the custom field in the Front UI. The value of the key must use the same type specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

Example request

{
  "custom_fields": {
    "city": "London, UK",
    "isVIP": true,
    "renewal_date": 1525417200,
    "sla_time": 90,
    "owner": "leela@planet-express.com",
    "replyTo": "inb_55c8c149",
    "Job Title": "firefighter"
  }
}

Response

An inbox

idstring

Unique identifier for the inbox

namestring

Name of the inbox

is_privateboolean

Whether or not the inbox is individual

is_publicboolean

Whether or not the inbox is available to all members of a team by default

custom_fieldsCustomFieldParameter

An object whose key is the name property defined for the custom field in the Front UI. The value of the key must use the same type specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/inboxes/inb_1ix6",
    "related": {
      "teammates": "https://yourCompany.api.frontapp.com/inboxes/inb_1ix6/teammates",
      "conversations": "https://yourCompany.api.frontapp.com/inboxes/inb_1ix6/conversations",
      "channels": "https://yourCompany.api.frontapp.com/inboxes/inb_1ix6/channels",
      "owner": "https://yourCompany.api.frontapp.com/teams/tim_k30"
    }
  },
  "id": "inb_1ix6",
  "name": "The Dundies",
  "is_public": true,
  "custom_fields": {
    "city": "London, UK",
    "isVIP": true,
    "renewal_date": 1525417200,
    "sla_time": 90,
    "owner": "leela@planet-express.com",
    "replyTo": "inb_55c8c149",
    "Job Title": "firefighter"
  }
}