Skip to Content

Replace all group members.

Overwrites the entire recipient list of a group route in a single call.

openemail.routes.replaceMembers(
  address: string,
  body: RoutesReplaceMembersBody,
  options?: CallOptions,
): ApiPromise<RoutesReplaceMembersResult>

It calls PUT /routes/{address}/members: Replace all group members in the API reference.

Example

const result = await openemail.routes.replaceMembers(address, { members: ['…'] })

Arguments

ArgumentTypeDescription
addressstringGroup route email address (e.g. 'team@example.com'). The path's {address}.
bodyRoutesReplaceMembersBodyThe 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, RoutesReplaceMembersResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_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
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Group route not found or not accessible to this principal
409inbound_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; the rest of the write stands)
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
503temporary_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

RoutesReplaceMembersBody

/** The body of `routes.replaceMembers`. */
type RoutesReplaceMembersBody = {
  /** Full list of replacement member addresses */
  members: string[]
}

RoutesReplaceMembersResult

/** What `routes.replaceMembers` answers. */
type RoutesReplaceMembersResult = {
  members: RouteMember[]
}

It names these types of the API, each on a page of its own: RouteMember.