Create a Group Action

Creates an action for a specific group.

See Parameters and Authentication below.

Sample Request

{
  "entity_action": {
    "type": "DefaultAction",
    "name": "test{{$randomInt}}",
    "is_active": "true",
    "deactivate_depreciation": "false",
    "is_returnable": "true",
    "perform_on_not_returned": "true",
    "change_return_name": "false",
    "return_name": "",
    "is_auto_returnable": "false",
    "is_creating_entity_objects": "false",
    "creates_entity_relation_attributes": {
      "creates_entity_id": "{{group_id}}",
      "id": ""
    },
    "on_web_perform_group_action_before_scan_records": "scan_first",
    "on_mobile_perform_group_action_before_scan_records": "scan_first",
    "allow_attachments": "no",
    "track_gps": "1"
  }
}

Sample Response

{
    "id": 263772,
    "name": "test769",
    "type": "DefaultAction",
    "key": "test769",
    "account_id": 14088,
    "entity_id": 86663,
    "has_all_entities": true,
    "has_all_statuses": true,
    "linked_action_id": null,
    "auto_return_linked_action": false,
    "linked_action_flags": null,
    "fields_counter": 0,
    "is_default": false,
    "is_returnable": false,
    "is_auto_returnable": false,
    "allow_attachment_on_open": false,
    "allow_attachment_on_return": false,
    "perform_on_not_returned": true,
    "created_at": "2022-03-23T20:43:29.007Z",
    "updated_at": "2022-03-23T20:43:29.007Z",
    "icon": null,
    "old_id": null,
    "ordering": 0,
    "track_gps": true,
    "return_name": "",
    "change_return_name": false,
    "deactivate_depreciation": false,
    "blocked_by_reservation_action_ids": null,
    "created_by": null,
    "is_system": false,
    "feature_id": 0,
    "is_creating_entity_objects": false,
    "on_web_perform_group_action_before_scan_records": "scan_first",
    "on_mobile_perform_group_action_before_scan_records": "scan_first",
    "on_web_populating_variable_fields": null,
    "on_mobile_populating_variable_fields": null,
    "entity_embed_id": null,
    "is_active": true
}

Parameters

Path Parameters	Required/Optional	Description	Type
`group_id`	required	The value for the group(s) you want to create.	string

Body Parameters	Required/Optional	Description	Type
`action`	required	The required object(s) of the actions you wish to create. See the Action Objects List below for the strings required to run your request.	objects

Action Objects List

The following action objects are all required strings:

type: The type of action you wish to create.
name: The name of the group action.
is_active: Is the group action active?
deactivate_depreciation: Do you wish for the group object to depreciate?
is_returnable: Is the object returnable?
perform_on_not_returned: Allow the creation of new action objects if other action objects are not returned?
change_return_name: Do you wish to display a custom name upon the return of the object?
return_name: What is the return name of the object?
is_auto_returnable: Does the action automatically move back into a returnable status?
is_creating_entity_objects: Does the action create records after the action is performed?
creates_entity_relation_attributes: You will also need to enter the ID of the entity to be created (creates_entity_id) along with the ID of the action (id).
on_web_perform_group_action_before_scan_records: Do you wish to perform the action before scanning the records. (For web.)
on_mobile_perform_group_action_before_scan_records: Do you wish to perform the action before scanning the records. (For mobile.)
allow_attachments: Do you wish users to be able to add attachments to the action?
track_gps: Do you wish for your action objects to have GPS coordinates?

Authentication

Key	Description
Authorization	Your Bearer token.

200Successful response