Delete a Composition Rule

Delete a Composition Rule from the specified Composition ID.

DELETE /1/compositions/{compositionID}/rules/{objectID}

curl

cURL

curl --request DELETE \
  --url https://algolia_application_id.algolia.net/1/compositions/my_composition_object_id/rules/lorem \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "taskID": 1514562690001
}

Required ACL: editSettings

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

compositionID · string · required

Unique Composition ObjectID. Composition unique identifier.

Example:

"my_composition_object_id"

objectID · string · required

Unique identifier of a rule object.

Response

200

application/json

OK

taskID · integer<int64> · required

Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this task ID.

Example:

1514562690001