routes.addMember
Add group member.
Adds a single recipient email address to a group route.
openemail.routes.addMember(
address: string,
body: RoutesAddMemberBody,
options?: CallOptions,
): ApiPromise<RouteMemberRef>It calls POST /routes/{address}/members: Add group member in the API reference.
Example
const routeMemberRef = await openemail.routes.addMember(address, { memberAddress: 'ada@example.com' })Arguments
| Argument | Type | Description |
|---|---|---|
address | string | Group route email address (e.g. 'team@example.com'). The path's {address}. |
body | RoutesAddMemberBody | The request's body. |
Options
It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
Awaited, it is the API's JSON, RouteMemberRef. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
400 | validation_failed, member_limit, invalid_member_address, self_membership — the group itself, by any spelling (a plus-tag or an alias-domain form both resolve back to it); destination_loops / destination_chain_too_long — the member's own delivery chain (a forward, a tap, a nested list) leads back into this group |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Group route not found or not accessible to this principal |
409 | member_exists; inbound_edge_cap: the member cannot accept another incoming delivery edge; route_changed: a concurrent edit replaced the membership while it was published (either names memberAddress) |
413 | too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing |
503 | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.
Types
RoutesAddMemberBody
/** The body of `routes.addMember`. */
type RoutesAddMemberBody = {
/** Email address to add to group */
memberAddress: string
}It names these types of the API, each on a page of its own: RouteMemberRef.