User Invitations

Create a user invitation

Invites a user (by email) to join the authenticated caller's organization with the specified roles.

post/v1/user_invitations

Request

  • Base URL
    https://identity-api.paymongo.com
  • URL
    https://identity-api.paymongo.com/v1/user_invitations
  • Auth
    none required

Request body

Example request

{
  "data": {
    "attributes": {
      "email": "alice@example.com",
      "roles": [
        "manage_users"
      ]
    }
  }
}

Response

Created

has_moreboolean

Example response

{
  "data": {
    "attributes": {
      "created_at": 1733097600,
      "email": "alice@example.com",
      "expires_at": 1735689600,
      "organization_id": "org_123",
      "organization_trade_name": "Hirthe and Sons",
      "roles": [
        "manage_users"
      ],
      "status": "pending",
      "token": "invt_xyz789",
      "updated_at": 1733097600
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.