POST/projects/api/v3/companies.json

Create a company.

Create a company.

Body Params

Request contains information of a company to be created or updated.

    • Name
      company
      Type
      object
      Description
      Company contains all the information returned from a company.
    • Name
      companyOptions
      Type
      object
    • Name
      tags
      Type
      array
      Description
      Tag contains all the information returned from a tag.

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
      Response contains information about a specific company.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      403
      Type
      object
      Schema
      Description
      403 Forbidden
      ErrorResponse defines how []Error should be marshaled to JSON.

    Examples

    201 Created

    Response
    {
  "company": {
    "accounts": 0,
    "addressOne": "string",
    "addressTwo": "string",
    "budgetDistribution": [
      {
        "color": "string",
        "companyId": 0,
        "count": 0,
        "from": 0,
        "to": 0
      }
    ],
    "canSeePrivate": true,
    "cid": "string",
    "city": "string",
    "clientManagedBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "clients": 0,
    "collaborators": 0,
    "companyNameUrl": "string",
    "companyUpdate": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "contacts": 0,
    "countryCode": "string",
    "createdAt": "string",
    "emailOne": "string",
    "emailThree": "string",
    "emailTwo": "string",
    "fax": "string",
    "id": 0,
    "industry": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "industryId": 0,
    "isOwner": true,
    "logoUrl": "string",
    "name": "string",
    "phone": "string",
    "privateNotes": "string",
    "privateNotesText": "string",
    "profileText": "string",
    "profitability": {
      "billable": 0,
      "billableTime": 0,
      "cost": 0,
      "expenses": 0,
      "loggedTime": 0,
      "nonBillableTime": 0,
      "profit": 0
    },
    "state": "string",
    "stats": {
      "projectCount": 0,
      "taskCompleteCount": 0,
      "taskCount": 0,
      "unreadEmailCount": 0
    },
    "status": "string",
    "tags": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "updatedAt": "string",
    "website": "string",
    "zip": "string"
  },
  "included": {
    "countries": {
      "additionalProp": {
        "code": "string",
        "country": "string",
        "eu": true,
        "phoneCode": "string",
        "vatName": "string",
        "vatPercent": 0
      }
    },
    "customfieldCompanies": {
      "additionalProp": {
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "countryCode": "string",
        "createdAt": "string",
        "createdBy": 0,
        "currencySymbol": "string",
        "customfield": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "customfieldId": 0,
        "id": 0,
        "urlTextToDisplay": "string"
      }
    },
    "customfields": {
      "additionalProp": {
        "createdAt": "string",
        "createdBy": 0,
        "createdByUserId": 0,
        "currencyCode": "string",
        "deleted": true,
        "deletedAt": "string",
        "deletedBy": 0,
        "deletedByUserId": 0,
        "description": "string",
        "entity": "string",
        "formula": "string",
        "groupId": 0,
        "id": 0,
        "isPrivate": true,
        "name": "string",
        "project": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "projectId": 0,
        "required": true,
        "type": "string",
        "updatedAt": "string",
        "updatedBy": 0,
        "updatedByUserId": 0,
        "visibilities": [
          "string"
        ]
      }
    },
    "industries": {
      "additionalProp": {
        "displayOrder": 0,
        "id": 0,
        "industryCategory": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "industryCategoryId": 0,
        "isActive": true,
        "isPublished": true,
        "name": "string"
      }
    },
    "tags": {
      "additionalProp": {
        "color": "string",
        "count": 0,
        "id": 0,
        "name": "string",
        "project": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "projectId": 0
      }
    },
    "updates": {
      "additionalProp": {
        "active": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "health": 0,
        "id": 0,
        "text": "string"
      }
    },
    "users": {
      "additionalProp": {
        "avatarUrl": "string",
        "canAddProjects": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "companyRoleId": 0,
        "deleted": true,
        "email": "string",
        "firstName": "string",
        "id": 0,
        "isAdmin": true,
        "isClientUser": true,
        "isServiceAccount": true,
        "jobRoles": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "lastName": "string",
        "lengthOfDay": 0,
        "meta": {},
        "teams": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timezone": "string",
        "title": "string",
        "type": "string",
        "userCost": 0,
        "userRate": 0,
        "workingHour": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "workingHoursId": 0
      }
    }
  }
}
    Download Swagger