Update contact with the Intercom API

Updates a contact: send only the fields to change. A user cannot become a lead. Every custom attribute sent must already exist in the workspace.

Identifier
intercom_update_contact

The request

POST https://connect.reportei.com/api/tools/intercom_update_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "contact_id": "<contact_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
contact_idstringYesId of the contact, from List contacts or Search contacts.
rolestringNouser turns a lead into a user. Sending lead for a user returns 400.Values: user, lead
external_idstringNoUnique id of the contact in your own system.
emailstringNoEmail address of the contact.
phonestringNoPhone number of the contact.
namestringNoName of the contact.
avatarstringNoURL of an image used as the avatar of the contact.
signed_up_atintegerNoWhen the contact signed up, as a Unix timestamp in seconds.
last_seen_atintegerNoWhen the contact was last seen, as a Unix timestamp in seconds.
owner_idstringNoId of the teammate who owns the contact, from List admins.
unsubscribed_from_emailsbooleanNotrue if the contact unsubscribed from emails.
language_overridestringNoPreferred language of the contact for the Messenger, such as pt-BR or en.
custom_attributesobjectNoCustom attribute values keyed by attribute name. Each attribute must already exist in the workspace.

Supported connections

Your customer connects their Intercom account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/intercom, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/intercom_update_contact. It becomes your agent's tool definition with no conversion.

Other Intercom tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.