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
id
stringRequiredThe invite's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
deleted_at
null | DateRequiredThe date with timezone at which the resource was deleted.
user_email
stringRequiredThe email of the user being invited.
The user's role. These roles don't change the privileges of the user.Default: member
member
accepted
booleanRequiredWhether the invite was accepted or not.
Default: false
token
stringRequiredThe token used to accept the invite.
expires_at
DateRequiredThe date the invite expires at.
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
Was this section helpful?