Sign in

v1

latestOpenAPI 3.1.02026-07-1414757122.7 KB
activities

Edit CRM activity

Updates an existing CRM activity. Only provided fields are changed.

patch/crm/v1/static/tasks/{itemId}

Request body

titlestring
createdByinteger
type'task' | 'call' | 'meeting' | 'chat' | 'email'
status'planned' | 'done' | 'cancelled'
descriptionstring
startTimeinteger
endTimeinteger
responsibleIdinteger
companyIdinteger
participantsinteger[]
dealsinteger[]
leadsinteger[]
contactsinteger[]

Example request

{
  "title": "Sed non massa",
  "createdBy": 5,
  "type": "meeting",
  "status": "planned",
  "description": "Duis id rutrum risus. Sed in urna.",
  "startTime": 1674950100,
  "endTime": 1674951000,
  "responsibleId": 5,
  "companyId": 67,
  "participants": [
    123,
    234,
    345
  ],
  "deals": [
    56
  ],
  "leads": [
    34
  ],
  "contacts": [
    12,
    32
  ]
}

Response

OK

idinteger
createdByinteger
titlestring
type'task' | 'call' | 'meeting' | 'chat' | 'email'
status'planned' | 'done' | 'cancelled'
descriptionstring
startTimeinteger
endTimeinteger
responsibleIdinteger
companyIdinteger
participantsinteger[]

Example response

{
  "title": "Title example",
  "startTime": 1674950100,
  "endTime": 1674951000,
  "responsibleId": 5,
  "participants": [
    123,
    234,
    345
  ],
  "contacts": [
    {
      "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"
        }
      ]
    }
  ],
  "deals": [
    {
      "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"
        }
      ]
    }
  ],
  "leads": [
    {
      "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"
        }
      ]
    }
  ],
  "company": {
    "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"
      }
    ]
  }
}