v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Comment

Delete All Comments By Entity Id

Deletes all comments for a given entity type and entity id

delete/api/v2/core/entity-comments/{entityType}/{entityId}

Path parameters

entityIdinteger required

Eightfold Entity ID

entityTypestring required

Eightfold Entity Type. Supported entity types: demand

Query parameters

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

Successfully deleted all comments

numDeletedCommentsinteger nullable

Number of comments deleted

entityIdinteger nullable

ID of the entity whose comments were deleted

entityTypestring nullable

Type of entity whose comments were deleted