08. Invitation

Post new invitation

post/public/v3/invitations

Request body

customer_type'Individual' | 'Business'

Customer type (enum: Individual, Business)

last_namestring

Last name

first_namestring

First name

company_namestring

Company name

emailstring required

phonestring

Phone number

referencestring required

Reference

send_emailboolean

Set if you want FriendlyScore to send email with invitation

Example request

{
  "customer_type": "Individual",
  "last_name": "John",
  "first_name": "Doe",
  "company_name": "Example INC.",
  "email": "john.doe@example.com",
  "phone": "+44123456789",
  "reference": "123-123-123"
}

Response

Returns CustomerInvitation

Changes

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