Calls POST /invitations/#{invitation_identity}/actions/send-verification

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "method": {
      "default": "sms",
      "description": "Transport used to send verification code",
      "enum": [
        "call",
        "sms"
      ],
      "example": "sms",
      "type": [
        "string"
      ]
    },
    "phone_number": {
      "description": "Phone number to send verification code",
      "example": "+1 123-123-1234",
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "phone_number"
  ],
  "type": [
    "object"
  ]
}

Calls GET /invitations/#{invitation_identity}

Calls POST /invitations

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "email": {
      "description": "unique email address of account",
      "example": "username@example.com",
      "format": "email",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "name": {
      "description": "full name of the account owner",
      "example": "Tina Edmonds",
      "readOnly": false,
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "email",
    "name"
  ],
  "type": [
    "object"
  ]
}

Calls PATCH /invitations/#{invitation_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "password": {
      "description": "current password on the account",
      "example": "currentpassword",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "password_confirmation": {
      "description": "current password on the account",
      "example": "currentpassword",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "receive_newsletter": {
      "description": "whether this user should receive a newsletter or not",
      "example": false,
      "readOnly": true,
      "type": [
        "boolean"
      ]
    }
  },
  "required": [
    "password",
    "password_confirmation"
  ],
  "type": [
    "object"
  ]
}

Calls POST /invitations/#{invitation_identity}/actions/verify

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "verification_code": {
      "description": "Value used to verify invitation",
      "example": "123456",
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "verification_code"
  ],
  "type": [
    "object"
  ]
}