SMsmileapi
Invites

Create Invite

Changed on

Create and send an invite to a user

post/invites

Request

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

Request body

fullNamestring required

The full name of the person to be invited

firstNamestring

The first name of the person to be invited

lastNamestring

The last name of the person to be invited

emailstring email required

Email of the person to be invited

templateIdstring required

The template ID to be used in the invite

winkTemplateIdstring

The Wink template ID used in the invitation

Example request

{
  "fullName": "George Cimafranca Palomero, Jr",
  "firstName": "George",
  "lastName": "Palomero",
  "email": "gpalomero1234@smileapi.io",
  "templateId": "tpl-b2c5e816-65ad-4130-819d-db89acc5869a",
  "winkTemplateId": "wtpl-db89acc5869a-b2c5e816-65ad-4130-819d"
}

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": {
    "id": "17bbf36498de4d68a0d4f86c7b62f69f",
    "createdAt": "2021-04-14T09:30:24Z",
    "fullName": "George Cimafranca Palomero, Jr",
    "firstName": "George",
    "lastName": "Palomero",
    "email": "gpalomero1234@smileapi.io",
    "templateId": "tpl-b2c5e816-65ad-4130-819d-db89acc5869a",
    "winkTemplateId": "wtpl-db89acc5869a-b2c5e816-65ad-4130-819d",
    "userId": "tenantId-b2c5e816-65ad-4130-819d-db89acc5869a",
    "updatedAt": "2021-04-14T09:30:24Z",
    "invitedAt": "2021-04-14T09:30:24Z",
    "linkedAt": "2021-04-14T09:30:24Z"
  }
}

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

  • v12ed9faaa61c0Revision changes
    • breaking

      request body became required