COcoevera
Document

CloudObjectFolders.create

Creates a CloudObjectFolder record.

post/entities/CloudObjectFolders

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

entity_api_namestring

API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.

entity_type1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only.

Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product

namestring required

Name of the entity and its default text representation.

online_form_type_idstring uuid

Id of the online form template, or empty when not associated with a form.

parent_cloud_object_folder_idstring uuid

Id of the parent folder, or empty for top-level folders.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "entity_api_name": "string",
  "entity_type": 1,
  "name": "string",
  "online_form_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "parent_cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

The created CloudObjectFolder record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "entity_api_name": "string",
    "entity_type": 1,
    "name": "string",
    "online_form_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.