In this section, we’re going to Delete a contact.person Object from your Data Store. Refer to the relevant documentation for the Objects for more information about the fields contained within the Object. We’ll delete the Object that we created in the previous section.
To do this, we need to use the DELETE HTTP method to send our query to the Objects action API end-point.
| Parameter | Description |
|---|---|
| object | The Object that you want to get – e.g., contacts.person |
| my_field | One or more fields can be specified that the Data Processor will filter on to decide which Objects to Delete from your Collection. WARNING: If you don’t specify any fields to filter on, then ALL Objects will be deleted from the Collection. |
In this example, we’re going to the delete the Object using the UUID (unique ID for the Object) that was returned when we created the Object in the earlier section.
Request:DELETE: https://api.spacetagcloud.net/objects/v1/action?object=contacts.person&uuid=423dcc76-652...
Headers:x-spacetag-app-uuid: 0b8d10be-87 ...
x-api-key: bca011a6-9375-11 ...
Using Postman #
In Postman it would look like this, based on the set-up in the previous sections.
If the request is successful then the API will respond with a 200 OK status and the following response:
There are also a number of other ways you can delete your Objects with filters and searches which is explained in a later section.
Using Curl #
This is an example of how you would get an Object using a command-line utility such as Curl.
curl -X DELETE -H "x-spacetag-app-uuid: 0b8d10be-87 ..." -H "x-api-key: bca011a6-9375-11 ..." https://api.spacetagcloud.net/objects/v1/action?object=contacts.person&uuid=423dcc76-652...