Documentation

Configurable Activities

Methods for handling a configurable activity.

Scope: catalog Permissions to execute: for all

Method Description Available from version
crm.activity.configurable.get Gets activity details. 23.0.0
crm.activity.configurable.add Adds an activity 23.0.0
crm.activity.configurable.update Updates an activity 23.0.0

General method for Activity entity to be used:

  1. To delete an Activity, you can use the general method for crm.activity.delete.
  2. You can get list of activities, you can use the general method for crm.activity.list with filter by PROVIDER_ID = CONFIGURABLE_REST_APP.

Activity fields

Field Description Type
typeId Configurable activity type. If not specified, sets a default value CONFIGURABLE. In case the value must match to one of types created via the method crm.activity.type.add with field IS_CONFIGURABLE_TYPE set as Y in the context of the same REST application.
completed Defines a closed activity bool. Available values: Y/N,1/0, true/false.
deadline Deadline datetime
pingOffsets Array with offsets in seconds compared to deadline, defining when you need to generate records/pings for this activity array
isIncomingChannel Activity from incoming channel bool. Available values: Y/N,1/0, true/false.
responsibleId Responsible user
badgeCode Badge code in Kanban, matching to the activity (see crm.activity.badge.list). string
originatorId Data source ID string
originId Element ID in data source string
© «Bitrix24», 2001-2024
Up