Create a Validation Invite
POST/v1/validation-invites
Create a Validation Invite
Request​
- application/json
Body
required
redirectUrl url
Possible values: <= 255 characters
Url that the hosted form redirects to after the flow is completed
metadata object
You can use this parameter to attach key-value data to a Validation Invite
language string
Valid RFC 5646 language code
hostedConfigId string
Hosted configuration id
Responses​
- 200
- 400
- 401
- 403
Successfully created a Validation Invite
- application/json
- Schema
- Example (from schema)
Schema
data object
id string
status string
Possible values: [open
, expired
, complete
]
metadata objectnullable
Key-value data that you can attach to an object.
language string
Defaults to en-GB
redirectUrl url
Url that the hosted form redirects to after the flow is completed
url url
Dynamic Hosted form URL for the validation invite
createdAt date-time
expiresAt date-time
object string
{
"data": {
"id": "validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status": "open",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"language": "en-GB",
"redirectUrl": "https://example.com/finish",
"url": "https://validation.poweredbypercent.com/validate/validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx?token=asasjhd",
"createdAt": "2020-10-13T17:46:54.000Z",
"expiresAt": "2020-10-20T17:46:54.000Z"
},
"object": "validation_invite"
}
Bad request
- application/json
- Schema
- Example (from schema)
- IncorrectParams
Schema
error object
code string
title string
message string
reasons string[]nullable
{
"error": {
"code": "string",
"title": "string",
"message": "string",
"reasons": [
"string"
]
}
}
400 Incorrect Parameters
{
"error": {
"code": "bad_request",
"title": "Bad request",
"message": "One or more of the inputs were invalid",
"reasons": [
"pageSize must be greater than or equal to 0"
]
}
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
code string
title string
message string
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}
Loading...