Resource URL

https://api.digitalchalk.com/api/zapier/user

Overview

The User API allows creation of DigitalChalk users (students) from the Zapier DigitalChalk application.  Retrieval of users is not implemented for this API as it not needed for the Zapier DigitalChalk application.

Use Cases

POST REQUEST

Operation Call Description
Create DigitalChalk User POST /api/zapier/user Creates a new user in the DigitalChalk system.

POST BODY EXAMPLE

{
    "firstName" : "John",
    "lastName" : "Smith",
    "emailAddress" : "john.smith@example.com",
    "username" : "jsmith1"
}
  • firstName – the first name of the new user
  • lastName – the last name of the new user
  • emailAddress – the email address of the new user
  • username – the username of the new user (optional: if not given, emailAddress is also used as username)

POST RESPONSE EXAMPLE

{
    "id": "ff8081817bef5dcb017bef924ed70001",
    "firstName": "John",
    "lastName": "Smith",
    "username": "jsmith1",
    "emailAddress": "john.smith@example.com",
    "localeCode": "en"
}
  • id – the DigitalChalk internal ID of this user
  • firstName – the first name of the new user
  • lastName – the last name of the new user
  • username – the username of the new user
  • emailAddress – the email address of the new user
  • localeCode – the locale of the new user (default to “en”, but may be set differently by organization rules)

Note: Other fields may be returned by this call, depending on the organization rules and other factors inside DigitalChalk.

Authentication

DigitalChalk API key as header X-API-KEY.  Normally, this is Zapier’s {{bundle.authData.api_key}}