Skip to main content
PATCH
/
objects
/
{id}
Update customer object
curl --request PATCH \
  --url http:localhost:3000/v2/objects/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "_id": "<string>",
  "number": 123,
  "companyId": "<string>",
  "status": {
    "status": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "lastModifiedAt": "2023-11-07T05:31:56Z",
    "lastModifiedBy": "<string>"
  },
  "chatId": "<string>",
  "customerId": "<string>",
  "name": "<string>",
  "contact": {
    "phone": "<string>",
    "email": "jsmith@example.com",
    "fax": "<string>"
  },
  "contract": {
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z"
  },
  "objectManagerId": "<string>",
  "material": [
    {
      "articleId": "<string>",
      "budget": 123
    }
  ],
  "address": {
    "street": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "country": "<string>"
  },
  "location": {
    "latitude": 123,
    "longitude": 123
  },
  "rating": 2.5,
  "description": "<string>",
  "securityCode": "<any>",
  "key": "<any>",
  "orderDescription": "<string>",
  "contactName": "<string>",
  "invoiceRecipientId": "<string>",
  "invoiceCCRecipientIds": [
    "<string>"
  ],
  "serviceRecipient": "<string>",
  "contactIds": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ]
}'
{
  "_id": "<string>",
  "number": 123,
  "companyId": "<string>",
  "status": {
    "status": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "lastModifiedAt": "2023-11-07T05:31:56Z",
    "lastModifiedBy": "<string>"
  },
  "chatId": "<string>",
  "customerId": "<string>",
  "name": "<string>",
  "contact": {
    "phone": "<string>",
    "email": "jsmith@example.com",
    "fax": "<string>"
  },
  "contract": {
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z"
  },
  "objectManagerId": "<string>",
  "material": [
    {
      "articleId": "<string>",
      "budget": 123
    }
  ],
  "address": {
    "street": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "country": "<string>"
  },
  "location": {
    "latitude": 123,
    "longitude": 123
  },
  "rating": 2.5,
  "description": "<string>",
  "securityCode": "<any>",
  "key": "<any>",
  "orderDescription": "<string>",
  "contactName": "<string>",
  "invoiceRecipientId": "<string>",
  "invoiceCCRecipientIds": [
    "<string>"
  ],
  "serviceRecipient": "<string>",
  "contactIds": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ]
}

Path Parameters

id
string<objectid>
required

Customer object ID

Body

application/json

Customer object data to update

A customer object represents a location or building where services are performed Base class for all entities that can have a chat associated with them. Base class for all entities in the system, providing common properties and methods.

customerId
string<objectid>
required

The Customer this object belongs to

address
object
required

Physical address of the object

number
integer
required

Unique number of the entity, used for identification

name
string

Name of the customer object

contact
object

Contact information for the object

contract
object

Contract information

objectManagerId
string<objectid> | null

The user responsible for managing this object

material
object[]

Material closet items for this object

location
object

GPS coordinates of the object

rating
number

Quality rating of the object

Required range: 0 <= x <= 5
description
string

Additional description or notes

securityCode
any

Security access code for the object

key
any

Key information or access details

orderDescription
string

Order-specific description

contactName
string

Name of the contact person at the object

invoiceRecipientId
string<objectid> | null

Contact ID for invoice recipient

invoiceCCRecipientIds
string<objectid>[]

Contact IDs for invoice CC recipients

serviceRecipient
string | null

Service recipient information

contactIds
string<objectid>[]

Contact IDs associated with the object

tags
string[]

Tags associated with the object

_id
string<objectid>

Unique identifier of the entity

companyId
string<objectid>

The ID of the company this entity belongs to

status
object

Entity Status information

chatId
string<objectid> | null

ID of the chat associated with this entity

Response

Customer object updated successfully

A customer object represents a location or building where services are performed Base class for all entities that can have a chat associated with them. Base class for all entities in the system, providing common properties and methods.

customerId
string<objectid>
required

The Customer this object belongs to

address
object
required

Physical address of the object

number
integer
required

Unique number of the entity, used for identification

name
string

Name of the customer object

contact
object

Contact information for the object

contract
object

Contract information

objectManagerId
string<objectid> | null

The user responsible for managing this object

material
object[]

Material closet items for this object

location
object

GPS coordinates of the object

rating
number

Quality rating of the object

Required range: 0 <= x <= 5
description
string

Additional description or notes

securityCode
any

Security access code for the object

key
any

Key information or access details

orderDescription
string

Order-specific description

contactName
string

Name of the contact person at the object

invoiceRecipientId
string<objectid> | null

Contact ID for invoice recipient

invoiceCCRecipientIds
string<objectid>[]

Contact IDs for invoice CC recipients

serviceRecipient
string | null

Service recipient information

contactIds
string<objectid>[]

Contact IDs associated with the object

tags
string[]

Tags associated with the object

_id
string<objectid>

Unique identifier of the entity

companyId
string<objectid>

The ID of the company this entity belongs to

status
object

Entity Status information

chatId
string<objectid> | null

ID of the chat associated with this entity