Intercom API (unofficial showcase)
DELETE/notes/{note_id}

Delete a note

Deletes a note attached to a contact or company. Use note_id to identify the note to remove. Notes of other kinds cannot be deleted through the API.

2 parameters
note_idintegerrequired
The unique integer identifier of the note to delete.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; supported values include the versions listed in the schema.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

4 status codes
200Returns a deletion object containing the supplied note identifier, the `note` object type, and a boolean indicating whether deletion succeeded.
idstringoptional
The unique identifier for the note which you provided in the URL.
typestringoptional
The type of object which was deleted. - `note`
Allowed:note
deletedbooleanoptional
Whether the note was deleted successfully or not.
400Returned when the note resource is not available for deletion.

One documented failure

  • intercom_version_invalid

    Requested resource is not available in current API version.

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the requested note does not exist.

One documented failure

  • not_found

    Resource Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when the note is not available for deletion, including when it is a kind other than a contact or company note. A 401 is returned when the request is unauthorized; send valid API credentials. A 404 is returned when no note exists with the specified note_id path parameter.