create a new invitation for a new user/vendor

post

https://api.securityscorecard.io/invitations

Body Params

user/vendor invitation info

string

required

first_name

string

required

last_name

string

required

target_url

string

optional url to take the invitee to when arriving to the platform. if specified, must be an internal route and only some routes are allowed for security reasons (please validate this in advance, or value could be ignored)

message

string

required

extra messaging for the invitee

branding_url

string

branding logo url

domain

string

the invited company domain

grade_to_maintain

string

minimum grade that an inviter requests an organization to maintain

days_to_resolve_issue

integer

minimum days to resolve a scorecard issue

sendme_copy

boolean

whether we should send a copy to the requesting user

notify_inviter

boolean

Defaults to true

whether we should notify to invert user

skip_notifications

boolean

whether we should send skip the notification

cc_requester

boolean

CC the inviter on the email

sender_email

string

Email of the user requesting the invite

sender_domain

string

Domain of the user requesting the invite

Response

201

No response body

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here!