SMsmileapi
Users

Create User

Changed on

Create a user in the Smile Network.

post/users

Request

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

Request body

externalMetadataObjectExternalMetadata

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:

  • The JSON values must be Strings (no nested JSON objects allowed)
  • Only ASCII characters can be used
  • Maximum of 5 key/value pairs
  • Maximum key length of 50 characters
  • Maximum value length of 500 characters

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": {
    "user": {
      "id": "17bbf36498de4d68a0d4f86c7b62f69f",
      "createdAt": "2021-04-14T09:30:24Z",
      "providers": [
        "upwork"
      ],
      "session": {
        "userId": "tenantId-123abc456def789abc123def456abc78",
        "channelId": "site-123abc456def789abc123def456abc78",
        "status": "IN_PROGRESS"
      }
    },
    "token": {
      "expiresAt": "2021-04-14T09:30:24Z",
      "mode": "SANDBOX"
    }
  }
}

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

  • v12c7cb8512390Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property default value was added for the status

    • info

      response property data/user/providers deprecated