You don’t have to populate the whole create check request every time. In case you use templates, you can refer to a template and then omit certain fields which will be copied from the referred templates.

• What is a template?

Here is an example of a very minimalistic create check call. In this case, there is a pre-defined template made by an administrator which holds a subject, language and the elements. The only thing that needs to be provided is the recipient and the way of sending the message.

• Method: POST

• URL: https://api.flixcheck.com/user/v7/checks

• Headers:

  • Content-Type: application/json
  • X-Flixcheck-UserId: <Your User ID>
  • X-Flixcheck-ApiKey: <Your API Key>

• Body:

  {
      "resource": {
          "recipient": {
              "gender": "female",
              "firstname": "Barabara",
              "lastname": "Streisand",
              "mobile": "017022222222"
          }
  				"sendBy": "sms",
  				"templateId": "<some template id>"
      }
  }
  

  • For more information about the recipient, see Recipient Properties

• Response:

  {
      "resource": {
          "id": "xxx",
          "subject": "The subject of the template",
          "code": "yYbxXxCe7",
          "answerLink": "<https://www.flixcheck.de/a/yYbxXxCe7>"
      }
  }
  

  • Tipp: Use the resource.id as Check ID in

    Get a single check

• as cURL