Skip to main content
POST
Account Members

Account Members

Members are contacts with a role: owner, admin or member. Account events pick recipients by role, and {{account.role}} is available in emails.
  • GET /api/v1/accounts/{externalId}/members lists members (owners first, then admins, then members)
  • POST /api/v1/accounts/{externalId}/members adds or updates a member
  • DELETE /api/v1/accounts/{externalId}/members removes a member

Request

string
required
Your organization ID.
number
default:"500"
GET only. Maximum members to return (up to 5,000).
string
Contact email. On POST, a new email creates the contact.
string
Contact external ID, as an alternative to email.
string
default:"member"
POST only. owner, admin or member. Re-adding an existing member with a role updates it; without a role keeps the current one.
string
POST only. Set when creating the contact.
string
POST only. Set when creating the contact.

Responses