Skip to content

Submit answers to a form

POST
/api/{referralpartner}/form

Submit answers to a form. The submission is validated against the form’s configuration and the referrer’s settings.

If successful, returns a 201 Created status code with a link header to the matched products route.

referralpartner
required
string
x-captcha-token
string
slug
string
ipAddress

The end-user’s IP address

string

The end-user’s IP address

object
referralCode

The referral code used to refer this submission

string
nullable
key
additional properties

Created

Bad Request

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
errors
object
key
additional properties
Array<string>
key
additional properties

Not Found

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

Too Many Requests

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties