{"_id":"58a2ab7c2ae7ed0f00d36e5b","category":{"_id":"55494a226a82a10d00817ae5","project":"55208137623ff50d009b2bec","version":"55208137623ff50d009b2bef","__v":15,"pages":["55494ad0ee219b0d001743bb","55494b05f452670d00ec0c29","55494b11ee219b0d001743bf","55494b20ee219b0d001743c1","55494b2bee219b0d001743c3","55494b4a6a82a10d00817af5","55494b686a82a10d00817af9","5549651ccd09b317005f8f50","55497273cd09b317005f8f86","554977f0c634cf2d001250a7","55b970eab42b610d00c9b2e3","5696f3688560a60d00e2c216","5696f91c59a6692d003fad50","5696f92c24490c3700170a2d","5696f9700b09a41900b24422"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-05-05T22:54:26.925Z","from_sync":false,"order":2,"slug":"public-api","title":"Public API"},"project":"55208137623ff50d009b2bec","__v":3,"parentDoc":null,"user":"579145f1180e233400f70ef0","version":{"_id":"55208137623ff50d009b2bef","__v":14,"project":"55208137623ff50d009b2bec","createdAt":"2015-04-05T00:26:31.564Z","releaseDate":"2015-04-05T00:26:31.563Z","categories":["55208138623ff50d009b2bf0","55494a226a82a10d00817ae5","55494ba7ee219b0d001743c8","55494bc1ee219b0d001743cc","56ead8c1df765617008bccaf","573a2073dd007d1700cf288f","579695b1f64c9f0e007cd76c","57969e3dfa1ff60e006a1274","579a4592fd9f3c0e008e4f4a","57ab9afe54fa780e006c5430","57b784f5b7ebd60e009cb4a6","58f686818193090f008cec76","59e79fbd4cf31900341d50c6","5b2436973fd93f0003dcf99d"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-14T07:02:20.312Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"curl 'https://www.sendsonar.com/api/v1/customers/properties' \\\n   -X DELETE \\\n   -H 'X-Token:XXXXXXXXXXXXXXXXXXXXX' \\\n   -H \"Content-Type: application/json\" \\\n   -d '{\"phone_number\": \"+13105551234\", \"email\": \"matt:::at:::sendsonar.com\", \"property_name\": \"delete_me\"}'","language":"curl"}]},"method":"delete","results":{"codes":[{"language":"json","code":"{ \"phone_number\": \"+13105551234\",\"email\": \"matt@sendsonar.com\", \"property_name\": \"delete_me\", \"deleted\": true }","name":"","status":200}]},"auth":"required","params":[{"_id":"58a2abe53dfce00f00e37550","ref":"","in":"body","required":false,"desc":"The phone number of the customer you want to add. This is the unique identifier for a customer. Required only if you're not including the email parameter.","default":"+13105551234","type":"string","name":"phone_number"},{"_id":"58a2ac6f71f6b70f007496ff","ref":"","in":"body","required":false,"desc":"Email address of the customer. Required only if you're not including the phone_number parameter.","default":"","type":"string","name":"email"},{"_id":"58a2ac6f71f6b70f007496fe","ref":"","in":"body","required":true,"desc":"The exact name of the property you'd like to delete for the customer","default":"","type":"string","name":"property_name"}],"url":"/customers/properties"},"isReference":true,"order":7,"body":"The Delete Customer Properties API requires either a phone_number or email (for Facebook Messenger customers). Phone numbers are guaranteed to be unique, so this is the preferred method to delete properties. The email must be unique to the customer in order for us to delete properties.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Country Code\",\n  \"body\": \"Please always include a country code (such as +1 for US) in all API calls to us.\"\n}\n[/block]","excerpt":"","slug":"delete-customer-properties","type":"endpoint","title":"DELETE Customer Properties"}

deleteDELETE Customer Properties


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

phone_number:
string+13105551234
The phone number of the customer you want to add. This is the unique identifier for a customer. Required only if you're not including the email parameter.
email:
string
Email address of the customer. Required only if you're not including the phone_number parameter.
property_name:
required
string
The exact name of the property you'd like to delete for the customer

Examples


Result Format


Documentation

The Delete Customer Properties API requires either a phone_number or email (for Facebook Messenger customers). Phone numbers are guaranteed to be unique, so this is the preferred method to delete properties. The email must be unique to the customer in order for us to delete properties. [block:callout] { "type": "info", "title": "Country Code", "body": "Please always include a country code (such as +1 for US) in all API calls to us." } [/block]