SMsmileapi
Consent Templates

Create Consent Template

Changed on

Create a consent template

post/consentTemplates

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/consentTemplates
  • Auth
    HTTP basic

Request body

consentTypestring required

The type of consent template, e.g. Terms and Conditions

titlestring

The name of the consent document that will be visible to end users if you choose to make it visible.

versionstring required

The version of the consent template

consentMethodstring

The method of consent

consentTextstring required

The content of the consent template

Example request

{
  "consentType": "Terms and Conditions",
  "title": "Terms and Conditions",
  "version": "1.0.0",
  "consentMethod": "I agree to the terms and conditions",
  "consentText": "<consent content>"
}

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "createdAt": "2021-04-14T09:30:24Z",
    "consentType": "Terms and Conditions",
    "title": "Terms and Conditions",
    "version": "1.0.0",
    "consentMethod": "I agree to the terms and conditions",
    "consentText": "<consent content>"
  }
}

Changes

  • v13bcbeecafbabRevision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

  • v15cff755a0d41Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status