Add Customer Email
helpscout.create_customer_email
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Add an email address to an existing customer.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Help Scout
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- mailbox_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
customer_id The numeric id of the customer to add the address to. | string | Yes | — | — | — |
email The email address to add. | string | Yes | — | email format | — |
email_type Where this address belongs. | string | No | work | one of "home", "other", "work" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"email_type": "work"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
created True once Help Scout answered 201 Created. | boolean | — |
kind Which resource was created: conversation, thread, customer or email. | string | — |
id The new resource's id, read from the Resource-ID response header. | string | — |
location The API URL of the new resource, from the Location header. | string | — |
web_location The Help Scout web URL of the new resource, when sent. | string | — |
status The HTTP status Help Scout answered with. | number | — |
customer_id The customer that was acted on. | string | — |
{
"created": false,
"customer_id": "",
"id": "",
"kind": "",
"location": "",
"status": 0,
"web_location": ""
}See Add Customer Email run in a workflow.
In a technical demo we add the Help Scout connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.