PATCH/projects/api/v3/companies/{companyId}.json

Update an existing company.

Modify the properties of an existing company.

Path Params

  • Name
    companyId
    Type
    integer
    required
    Description

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
      200
      Type
      object
      Schema
      Description
      200 OK
      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.
    • Code
      404
      Description
      404 Not Found No Data
    • Code
      409
      Type
      object
      Schema
      Description
      409 Conflict
      ErrorResponse defines how []Error should be marshaled to JSON.

    Examples

    200 OK

    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": {