Intercom API (unofficial showcase)
POST/companies/{company_id}/notes

Create a note for a company

Creates a note associated with a specific company. Include the note text in body; you can optionally specify admin_id to set the note's author, otherwise the admin associated with the access token is used.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 2 body fields
company_idstringrequired
The unique identifier of the company to associate the note with.
Intercom-Versionstringoptional
API version to use for the request. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Company note content and optional author identifier.

bodystringrequired
The text of the note.
admin_idstringoptional
The unique identifier of the admin creating the note. If not provided, defaults to the admin associated with the access token.

3 status codes
200Returns the created note, including its identifier, creation time, associated company, author, and note text.
typestringoptional
String representing the object's type. Always has the value `note`.
idstringoptional
The id of the note.
created_atintegeroptional
The time the note was created.
contactobjectoptional
Represents the contact that the note was created about.
companyobjectoptional
Represents the company that the note was created about.
authorobjectoptional
Admins are teammate accounts that have access to a workspace.
bodystringoptional
The body text of the note.
401Returned when the request is unauthorized.
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the company or specified admin does not exist.

2 documented failures

  • not_found

    Resource Not Found

  • company_not_found

    Company Not Found

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

Error handling

Omitting body from the request body is rejected because the note text is required. A 401 is returned when the request is unauthorized. A 404 is returned when the company or the specified admin_id does not exist.