Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Accounts

Create account

Create a new account.

Required scope: accounts:write

post/accounts

Request body

namestring

Name of the Account

descriptionstring

Account description

domainsstring[]

List of domains associated with the Account

external_idstring

ID of the Account in an external system

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 Account

idstring required

Unique identifier of the account

namestring required

Account name

logo_urlstring nullable required

URL of the Account's logo

descriptionstring nullable required

Account Description

domainsstring[] required

List of domains associated to the Account

external_idstring nullable required

ID of the Account in an External system, such as your backoffice system or CRM

custom_fieldsCustomFieldParameter required

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

created_atnumber

Timestamp when the account was created

updated_atnumber

Timestamp when the account was updated

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/accounts/acc_76",
    "related": {
      "contacts": "https://yourCompany.api.frontapp.com/accounts/acc_76/contacts"
    }
  },
  "id": "acc_76",
  "name": "Dunder Mifflin, Inc.",
  "logo_url": "https://yourCompany.api.frontapp.com/accounts/acc_aq/logo-1654309308278",
  "description": "Limitless Paper in a Paperless World",
  "custom_fields": {
    "city": "London, UK",
    "isVIP": true,
    "renewal_date": 1525417200,
    "sla_time": 90,
    "owner": "leela@planet-express.com",
    "replyTo": "inb_55c8c149",
    "Job Title": "firefighter"
  },
  "created_at": 1622672452.363,
  "updated_at": 1654309308.278
}