younifyd
Menu

Create Company Note

Create a company note

POST/companies/{company_id}/notes

Use it in a workflow

  1. Add a step and choose the Intercom connector.
  2. Pick the Create Company Note action (under Notes).
  3. Fill in the fields below, then reference the result from later steps as {{createCompanyNote.response.data}}.

Request

Path parameters

company_idstringrequired

The unique identifier for the company which is given by Intercom

Headers

Intercom-Versionstring

Intercom API version.</br>By default, it's equal to the version set in the app package.

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Request body

Enter the body as JSON in the step's Body field.

bodystringrequired

The text of the note.

admin_idstring

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

json
{
  "body": "New note",
  "admin_id": "991267583"
}

Response

Returns 200 with an object. Read it in later steps with {{createCompanyNote.response.data.<field>}}.

typestring

String representing the object's type. Always has the value `note`.

idstring

The id of the note.

created_atinteger (timestamp)

The time the note was created.

contactobject

Represents the contact that the note was created about.

typestring

String representing the object's type. Always has the value `contact`.

idstring

The id of the contact.

companyobject

Represents the company that the note was created about.

typestring

String representing the object's type. Always has the value `company`.

idstring

The id of the company.

authorobject

Admins are teammate accounts that have access to a workspace.

typestring

String representing the object's type. Always has the value `admin`.

idstring

The id representing the admin.

namestring

The name of the admin.

emailstring

The email of the admin.

job_titlestring

The job title of the admin.

away_mode_enabledboolean

Identifies if this admin is currently set in away mode.

away_mode_reassignboolean

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

away_status_reason_idinteger

The unique identifier of the away status reason

has_inbox_seatboolean

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

team_idsarray<integer>

This object represents the avatar associated with the admin.

avatarstring (uri)

Image for the associated team or teammate

team_priority_levelobject2 fields

Admin priority levels for teams

roleobject3 fields

The role assigned to this admin. Only present if the admin has a role assigned.

bodystring

The body text of the note.

json
{
  "type": "note",
  "id": "17495962",
  "created_at": 1674589321,
  "contact": {
    "type": "string",
    "id": "214656d0c743eafcfde7f248"
  },
  "company": {
    "type": "string",
    "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
  },
  "author": {
    "type": "admin",
    "id": "1295",
    "name": "Joe Example",
    "email": "jdoe@example.com",
    "job_title": "Associate",
    "away_mode_enabled": false,
    "away_mode_reassign": false,
    "away_status_reason_id": 12345,
    "has_inbox_seat": true,
    "team_ids": [
      814865
    ],
    "avatar": "https://picsum.photos/200/300",
    "team_priority_level": {
      "primary_team_ids": [
        814865
      ],
      "secondary_team_ids": [
        493881
      ]
    }
  },
  "body": "<p>Text for the note.</p>"
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.