Create Invitation

POST

/public/v3/invitations

Parameters

none

Query parameters

none

Request body parameters

ParameterData typeRequired?Description
customer_typeenumnoAllowed:(Individual, Business)
last_namestringnoLast name
first_namestringnoFirst name
company_namestringnoCompany name
emailstringyesEmail
phonestringnoPhone
referencestringyesUser reference
send_emailbooleannoSet to true if you want FriendlyScore to send email with invitation

Response body parameters

ParameterData typeRequired?Description
customer_typeenumnoAllowed:(Individual, Business)
last_namestringnoLast name
first_namestringnoFirst name
company_namestringnoCompany name
emailstringyesEmail
phonestringnoPhone
referencestringyesUser reference
send_emailbooleannoSet to true if you want FriendlyScore to send email with invitation

Request example

1 2 3 4 5 6 7 8 9 10 11 curl --location --request POST 'https://api.friendlyscore.com/public/v3/invitations' --data-raw '{ "customer_type": "Individual", "last_name": "John", "first_name": "Doe", "company_name": "Example INC.", "email": "john.doe@example.com", "phone": "+44123456789", "reference": "123-123-123", "send_email": false }'

Response example:

1 2 3 4 5 6 7 8 9 10 { "customer_type": "Individual", "last_name": "John", "first_name": "Doe", "company_name": "Example INC.", "email": "john.doe@example.com", "phone": "+44123456789", "reference": "123-123-123", "send_email": false }

Was this article helpful?

Friendly Score UK Ltd.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

Call us on +44 20 3709 6726

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 781963)