Sign in

v1

latestOpenAPI 3.1.02026-07-1414757122.7 KB
items

Edit CRM entity item

Updates an existing CRM entity item. Only provided fields are updated. Example: PATCH /crm/v1/entities/leads/14

patch/crm/v1/entities/{entity}/{itemId}

Request body

titlestring
ownerinteger
sourcestring

Example request

{
  "title": "Lead example",
  "owner": 1,
  "source": "shop",
  "email": [
    {
      "id": "",
      "type": "main",
      "value": "stark@gmail.com",
      "main": true
    },
    {
      "id": "01gdnpddf5xgzxqvcn4x83mc2s",
      "type": "work",
      "value": "benner@gmail.com",
      "main": false
    }
  ],
  "phone": [
    {
      "id": "01gdnpddf5xgzxqvcn4x83mc2s",
      "type": "WORK",
      "value": "+380123456789",
      "code": "+380"
    }
  ],
  "messengers": [
    {
      "id": "01gdnpddf5xgzxqvcn4x83bn2s",
      "type": "facebook",
      "link": "https://www.facebook.com"
    }
  ]
}

Response

OK

titlestring
ownerinteger
sourcestring
idinteger
created_byinteger
changed_byinteger
created_atinteger
updated_atinteger

Example response

{
  "title": "Lead example",
  "owner": 1,
  "source": "shop",
  "email": [
    {
      "id": "",
      "type": "main",
      "value": "stark@gmail.com",
      "main": true
    },
    {
      "id": "01gdnpddf5xgzxqvcn4x83mc2s",
      "type": "work",
      "value": "benner@gmail.com",
      "main": false
    }
  ],
  "phone": [
    {
      "id": "01gdnpddf5xgzxqvcn4x83mc2s",
      "type": "WORK",
      "value": "+380123456789",
      "code": "+380"
    }
  ],
  "messengers": [
    {
      "id": "01gdnpddf5xgzxqvcn4x83bn2s",
      "type": "facebook",
      "link": "https://www.facebook.com"
    }
  ],
  "id": 12,
  "created_by": 1,
  "changed_by": 1,
  "created_at": 12156465,
  "updated_at": 12156465
}