POST
/
api
/
loyalty
/
questions
import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const question = await client.loyalty.questions.create({
    loyaltyQuestionAnswers: [{ isCorrect: true, sortIdentifier: 1, text: 'Red' }],
    loyaltyRuleId: '123e4567-e89b-12d3-a456-426614174000',
    questionText: 'What is your favorite color?',
  });

  console.log(question.id);
}

main();
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "text": "<string>",
  "loyaltyQuestionChoices": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "text": "<string>",
      "sortIdentifier": 123
    }
  ]
}

Body

application/json
Body
loyaltyRuleId
string
required

UUID of the loyalty rule

Example:

"123e4567-e89b-12d3-a456-426614174000"

questionText
string
required

The text of the question

Example:

"What is your favorite color?"

loyaltyQuestionAnswers
object[]
required

Array of choices for the question

allowMultipleAttempts
boolean
default:false

Whether the question allows multiple attempts

Example:

false

Response

201
application/json
201

Response returned for a question

id
string
required
text
string
required
loyaltyQuestionChoices
object[]
required