Staff

  • Create a new staff member

    POST /api/1/staff.json
    Formats
    json jsonp

    Creates a new staff member. Requires a valid user object to be posted.

    Please Note: This may cause a charge for the user. If this is the case, they will receive an email asking them to confirm the creation of a new user

    Errors
    • 401 Unauthorized
    • 402 Payment Required - if the authenticated user is on a plan with a maximum number of staff, and this user will take them over this limit, they will need to upgrade their plan.
    • 422 Invalid Record - if the staff member fails validation. An error message will be returned, declaring the error.
    Example
    POST /api/1/staff
    {
      "staff": {
        "active": "true",
        "email_address": "5jewel_kovacek@mertz.com",
        "first_name": "Sage",
        "hourly_rate_cents": null,
        "last_name": "Dicki",
        "login": "user5",
        "time_zone": "Australia/Perth",
        "type": "staff"
      }
    }
    200
    {
      "response": {
        "active": "true",
        "email_address": "5jewel_kovacek@mertz.com",
        "first_name": "Sage",
        "hourly_rate_cents": null,
        "last_name": "Dicki",
        "login": "user5",
        "time_zone": "Australia/Perth",
        "uuid": "694b9cd4-aa9a-47a1-b76c-1bca7c19a640",
        "type": "staff"
      }
    }
    Parameters
    • staff

      A staff member JSON object.

      • uuid

        A UUID to identify the user. If null, one will be generated

      • login

        User’s login

      • first_name

        User’s first name

      • last_name

        User’s first name

      • email_address

        User’s email address

      • time_zone

        Time zone of the staff

      • active

        Indicates whether the user is active or not. Note: This is a string.

      • type

        Indicates the user type. This is read only - sending this attribute will be ignored.

      • hourly_rate_cents

        The user’s hourly rate in cents