POST/desk/api/v2/companies.json

Create a new company.

Body Params

A Company is a group of customers.

    • Name
      address
      Type
      object
    • Name
      avatarPath
      Type
      string
      Description
      A read-only domain + path where the company avatar can be accessed
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      customers
      Type
      array
    • Name
      customersCount
      Type
      integer
      Description
      Read-only count of the number of customers within the company
    • Name
      deletedAt
      Type
      string
      Description
      DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
    • Name
      deletedBy
      Type
      object
    • Name
      details
      Type
      string
      Description
      Optional reference data for the company
    • Name
      domains
      Type
      array
    • Name
      email
      Type
      string
      Description
      The email address that can be used to contact the company. This is used as reference data only.
    • Name
      filter_args
      Type
      object
      Description
      RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
    • Name
      id
      Type
      integer
    • Name
      industry
      Type
      string
      Description
      Optional reference field for the company's industry
    • Name
      kind
      Type
      string
      Description
      Specifies whether the company is a group (custom group of customers) or a company, added automatically via domain matching.
    • Name
      name
      Type
      string
      Description
      The unique name of the company which can be filtered on throughout the application: reports, search, and views.
    • Name
      permission
      Type
      string
      Description
      Specifies the access that customers within this company will have access to company tickets. The options are "own" and "all". When "own" customers can only view their own tickets within the portal. When "all" customers can see their tickets as well as all tickets from all members of the company. This setting can be overridden per customer.s
    • Name
      phones
      Type
      array
    • Name
      pmcompany
      Type
      object
    • Name
      sociallinks
      Type
      array
    • Name
      state
      Type
      string
      Description
      State is the status of the object. Typically this will be either active or deleted. When deleted the `deletedAt` and `deletedBy` relationship will be returned.
    • Name
      ticketsCount
      Type
      integer
      Description
      Read-only count of the number of tickets within the company
    • Name
      unreadTicketsCount
      Type
      integer
      Description
      Read-only count of the number of unread tickets within the company
    • Name
      updatedAt
      Type
      string
      Description
      UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
    • Name
      updatedBy
      Type
      object
    • Name
      website
      Type
      string
      Description
      Optional reference field for storing the company url

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
      CompanyAPIBody is the request/response format for the API
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    201 Created

    CompanyAPIBody
    {  "company": {    "address": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "avatarPath": "string",    "createdAt": "2024-12-04T16:22:47.687Z",    "createdBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },
    Download Swagger