user_invitation

Collection: user_invitations

Invitation for a user to access a certain store. The payload for a POST request should only include the invitee's email, which cannot match an existing email for the store. To resend an invitation, use the fx:resend link rel.

NOTE: Invitations sent in this way currently are not fully functional. Please contact us if you need to use this functionality.

Required Scopes

Full user_full_access
Read users_read
Write users_write

Actions

GET View a user invitation
PATCH Update a user invitation (send only the properties you want to modify)
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (10)

store_url String · Read-only

URL of the store that the user is invited to.

store_name String · Read-only

Name of the store that the user is invited to.

store_email String · Read-only

Email of the store that the user is invited to.

store_domain String · Read-only

Domain of the store that the user is invited to.

first_name String

First name of the user.

last_name String

Last name of the user.

email String · Required

Email of the user.

status String · Read-only

Status of the invitation.

sentacceptedrejectedrevokedexpired
date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (7)

self This User Invitation
fx:store GET PATCH PUT DELETE This Store
fx:resend Resend the email for this invitation
fx:user GET PATCH PUT DELETE This User
fx:accept POST Accept this user invitation.

Only present when the current user has permission to accept the invitation.

fx:reject POST Reject this user invitation.

Only present when the current user has permission to reject the invitation.

fx:revoke POST Revoke this user invitation.

Only present when the current user has store-level permission to revoke the invitation.

https://api.foxycart.com/user_invitations/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/user_invitations/123",
      "title": "This User Invitation"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:resend": {
      "href": "https://api.foxycart.com/resend",
      "title": "Resend the email for this invitation"
    },
    "fx:user": {
      "href": "https://api.foxycart.com/users/456",
      "title": "This User"
    }
  },
  "store_url": "http://www.example.com/",
  "store_name": "Example Store",
  "store_email": "john@example.com",
  "store_domain": "example",
  "first_name": "Mary",
  "last_name": "Smith",
  "email": "mary@example.com",
  "status": "sent",
  "date_created": "2022-12-01T10:07:05-0800",
  "date_modified": "2022-12-01T10:07:05-0800"
}