Create Workday Profile

This page documents the api-create-workday-profile function (as well as methods to edit the profile and resume once created). This functions is responsible for creating a Workday profile for a user.

Usage

Endpoint: `POST /api-create-workday-profile

Headers

  • Name
    Authorization
    Type
    string
    Description

    Bearer token containing the API key.

Request Body

  • Name
    credentials
    Type
    object
    Description
    • Name
      email
      Type
      string
      Description

      User's email address.

    • Name
      password
      Type
      string
      Description

      User's password (unhashed—will be hashed in account creation).

  • Name
    information
    Type
    object
    Description
    • Name
      first_name
      Type
      string
      Description

      User's first name.

    • Name
      last_name
      Type
      string
      Description

      User's last name.

    • Name
      address
      Type
      string
      Description

      User's address.

    • Name
      city
      Type
      string
      Description

      User's city.

    • Name
      county
      Type
      string
      Description

      User's county.

    • Name
      state
      Type
      string
      Description

      User's state.

    • Name
      postal_code
      Type
      string
      Description

      User's postal code.

    • Name
      phone_number
      Type
      string
      Description

      User's phone number.

  • Name
    experience
    Type
    object
    Description

    Contains work experience and school objects.

  • Name
    work_experience
    Type
    array
    Description

    Array of user's work experience objects.

  • Name
    experience example
    Type
    object
    Description
  • Name
    job_title
    Type
    string
    Description

    Title of the job.

  • Name
    company
    Type
    string
    Description

    Company name.

  • Name
    location
    Type
    string
    Description

    Location of the job.

  • Name
    current_job
    Type
    string
    Description

    Whether or not this job is the user's current job. "true" or "false".

  • Name
    start_date
    Type
    string
    Description

    Start date of the job. MM/YYYY format, ex: "01/2023".

  • Name
    end_date
    Type
    string
    Description

    End date of the job. Optional (if current_job is true). MM/YYYY format, ex: "06/2023".

  • Name
    description
    Type
    string
    Description

    Description of the job.

  • Name
    school
    Type
    array
    Description

    Array of user's school experience details.

  • Name
    school example
    Type
    object
    Description
  • Name
    school
    Type
    string
    Description

    Name of the school.

  • Name
    degree
    Type
    string
    Description

    Degree recieved. Options: "GED", "High School", "Associates", "Bachelors", "Masters", "Doctorate", "No Education".

  • Name
    field
    Type
    string
    Description

    Field of study.

  • Name
    gpa
    Type
    string
    Description

    GPA at this institution. Optional.

  • Name
    start_year
    Type
    string
    Description

    Starting year at this institution. YYYY format, ex: "2017". Optional.

  • Name
    end_year
    Type
    string
    Description

    Ending year, or expected ending year, at this institution. YYYY format, ex: "2021". Optional.

  • Name
    linkedIn
    Type
    string
    Description

    LinkedIn profile link.

  • Name
    filename
    Type
    string
    Description

    Filename of the user's resume.

  • Name
    resumeLink
    Type
    string
    Description

    Public link to the user's resume.

  • Name
    disclosures
    Type
    object
    Description
    • Name
      race
      Type
      string
      Description

      User's race/ethnicity. Options: 'American Indian or Alaska Native (Not Hispanic or Latino) (USA)', 'Black or African American (Not Hispanic or Latino) (USA)', 'Chose Not to Disclose (USA)', 'Hispanic or Latino (USA)', 'Native Hawaiian or Other Pacific Islander (Not Hispanic or Latino) (USA)', 'Two or More Races (Not Hispanic or Latino) (USA)', 'White (Not Hispanic or Latino) (USA)'.

    • Name
      hispanic_or_latino
      Type
      boolean
      Description

      Indicates if the user identifies as Hispanic or Latino.

    • Name
      gender
      Type
      string
      Description

      User's gender. Options: 'Female', 'Male', 'Not Disclosed'.

    • Name
      veteran_status
      Type
      string
      Description

      User's veteran status. Options: 'I IDENTIFY AS ONE OR MORE OF THE CLASSIFICATIONS OF PROTECTED VETERANS LISTED ABOVE', 'I IDENTIFY AS A VETERAN, JUST NOT A PROTECTED VETERAN', 'I AM NOT A VETERAN', 'I DO NOT WISH TO SELF-IDENTIFY'.

  • Name
    uid
    Type
    string
    Description

    Unique identifier for the user. Optional.

POST/api/api-create-workday-profile

Create Workday Profile

This endpoint accepts and creates profiles for a user. All required fields must be filled and verified according to the above schema.

Edit a User

Importantly, include the "uid" property (string) as a field in the function call to edit an existing profile instead of creating a new one. Editing a profile replaces the old profile with the new one specified, so include all fields when editing.

Edit a User's Resume

Resumes cannot be edited using the above function. Instead, call api-update-user-resume with a uid and an updated filename and link.

Request

POST
/api/api-update-user-resume
curl -X POST https://app.wranglejobs.com/api/api-update-user-resume \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {api-key}' \
  -d '{"uid": uid, "filename": filename, "resumeLink": resumeLink}'

Required attributes

  • Name
    uid
    Type
    string
    Description

    Id of the user you wish to edit the resume of.

  • Name
    uid
    Type
    string
    Description

    New name for the updated resume file.

  • Name
    resumeLink
    Type
    string
    Description

    Valid link accessable to the public to an updated resume.

Request

POST
/api/api-create-workday-profile
curl -X POST https://app.example.com/api/api-create-workday-profile \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${api-key}" \
  -d '{"userData": {...}}'

Response

{
  "message": "Success",
  "data": "User UID"
}

Errors

  • 400-411: Various validation or processing errors.
  • 500: "Internal server error"

Was this page helpful?