Skip to main content
Skip to main content

Invite

An invite is created when an admin user invites a new user to join the store's team. Once the invite is accepted, it's deleted.

Properties

acceptedbooleanRequired
Whether the invite was accepted or not.

Default: false

created_atDateRequired
The date with timezone at which the resource was created.
deleted_atnull | DateRequired
The date with timezone at which the resource was deleted.
expires_atDateRequired
The date the invite expires at.
idstringRequired
The invite's ID
metadataRecord<string, unknown>Required
An optional key-value map with additional details
roleUserRolesRequired
The user's role. These roles don't change the privileges of the user.

Default: member

tokenstringRequired
The token used to accept the invite.
updated_atDateRequired
The date with timezone at which the resource was updated.
user_emailstringRequired
The email of the user being invited.
Was this section helpful?