Skip to main content
POST
Update Inbox Members
Use this endpoint to manage who has access to an inbox. You can add and remove team members by email, and assign or unassign user groups by ID, in the same request. This endpoint changes inbox membership only. It does not create users, invite them to your team, or remove them from your team.
Get the inbox_id from GET /v1/inboxes and user group IDs from POST /v1/user-groups.
Emails and group IDs that do not match anything in your team do not fail the request. They are returned in the *_not_found arrays of the response so you can correct them.

Authorizations

Authorization
string
header
required

Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.

API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.

Use the following JWT values:

Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.

Sign the JWT with HMAC-SHA256 using this signing secret:

Send the signed JWT as a bearer token:

Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.

Body

application/json
inbox_id
integer
required
add_emails
string[]
remove_emails
string[]
add_group_ids
integer[]
remove_group_ids
integer[]

Response

the updated inbox, plus any emails and group ids that matched nothing on the team

inbox
object
required
add_emails_not_found
string[]

Emails from add_emails that matched no team member and no pending team invite. Omitted when empty.

remove_emails_not_found
string[]

Emails from remove_emails that matched no team member and no pending inbox invite. Omitted when empty.

add_group_ids_not_found
integer[]

Ids from add_group_ids that are not a user group on the team. Omitted when empty.

remove_group_ids_not_found
integer[]

Ids from remove_group_ids that are neither assigned to the inbox nor a user group on the team. Omitted when empty.

errors
object[]

Problems that did not stop the membership change, such as reassignment_failed. Omitted when empty.