FRfriendlyscore
08. Invitation

Post new invitation

Changed on
post/public/v3/invitations

Request

  • Base URL
    https://api.friendlyscore.com (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

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

Email

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

idstring
customer_type'Individual' | 'Business' required
last_namestring
first_namestring
company_namestring
emailstring required
phonestring
referencestring required
send_emailboolean
created_atstring date-time
revoked_atstring date-time
used_atstring date-time
expires_ininteger
urlstring

Example response

{
  "id": "12345",
  "customer_type": "Individual",
  "last_name": "Doe",
  "first_name": "John",
  "company_name": "Example INC.",
  "email": "example@example.com",
  "phone": "+44123456789",
  "reference": "some-reference-id",
  "created_at": "1553077496",
  "revoked_at": "1553077496",
  "used_at": "1553077496",
  "url": "https://friendlyscore.com/invitation/123456789abcdef"
}

Changes