Creating a Question Option
Creates a question option for a question on a collect page.
Method Info
| Url | https://www.payit2.com/api/v1/collect-page/{CollectPageId}/question/{QuestionId}/option |
|---|---|
| Verb | POST |
| Headers | X-PayItSquare-AppKey, X-PayItSquare-Token |
| {CollectPageId} | The id of the collect page. |
| {QuestionId} | The id of the question. |
Input
| Property | Data Type | Validation Info |
|---|---|---|
| Id | Guid | The Id of the question option. |
| OptionText | String | The text for the option that the user will see. |
| SortOrder | Int32 | The order that the option will be displayed. |
Output
| Property | Data Type | Other Info |
|---|---|---|
| Id | Guid | The id of the created object. It will be used as part of the url for subsequent updates. Only available if the creation was successful. |
| IsSuccess | Boolean | Indicates if the call was successful or not. |
| Messages | String Array | Will contain a list of error messages if IsSuccess is false |
Sample Input
{
"OptionText": "My Option",
"SortOrder": 2
}
Sample Success Response
{
"Id": "cd0c0a07-f7a9-4eab-ad0b-a537eeccc960",
"IsSuccess": true,
"Messages": []
}
Sample Error Response
{
"Id": "00000000-0000-0000-0000-000000000000",
"IsSuccess": false,
"Messages": [
"Error Message 1",
"Error Message 2"
]
}