Ruby

client.support

Every method in this namespace: its signature, its parameters, what it returns and an example.

Methods

Write to the people who build OpenEmail, as the contact page does. The reply goes by email to the account behind the client.

`support.send`

Write to OpenEmail support

No scope

Signature

send(body = nil, api_key: nil, **fields) -> Hash

Sends a message to the people who build OpenEmail, as the contact page does for somebody signed in. The name and the address the reply goes to come from the account behind the client: the workspace owner for an API key, and the person who connected the app for an access token. The workspace is named in the message, so support knows which one it is about.

Parameters

topicStringRequired: What it is about in a few words, up to 64 characters, such as Bug report or Domains & DNS.
messageStringRequired: The message itself, up to 8,000 characters.
api_keyString: Overrides the client's API key for this call only.

Returns

A Hash with the id of the message and replyTo, the address the reply will go to.

Example

sent = client.support.send(  topic: "Bug report",  message: "Scheduled sends to one address stay queued since this morning.") puts sent[:id], sent[:replyTo]

Notes

Needs no scope.
One address can send 3 messages in 10 minutes. The next one is 429 support_rate_limited, and nothing is recorded or sent.
The SDK does not retry it, because a second call would send a second message.

Also available in

API: POST /support
TypeScript: support.send()
Python: support.send()
CLI: openemail support send