Create Campaign - Step 1 | Gradii API Documentation

curl -X POST https://gradii.ai/api/v2/job-campaigns/create/step1 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "campaignName": "Senior Developer Hiring Q1 2024",
  "jobTitle": "Senior Software Engineer",
  "department": "Engineering",
  "location": "Bangalore, India",
  "experienceLevel": "Senior Level (6–10 years)",
  "employeeType": "Full-time",
  "numberOfOpenings": 3,
  "jobDescription": "We are looking for an experienced software engineer...",
  "salaryMin": 2000000,
  "salaryMax": 3500000,
  "currency": "INR",
  "jobDuties": "Design and develop scalable applications...",
  "requirements": "6+ years of experience with JavaScript...",
  "benefits": "Competitive salary, health insurance, remote work...",
  "skills": "JavaScript, React, Node.js, PostgreSQL",
  "campaignType": "specific",
  "applicationDeadline": "2024-12-31T23:59:59Z",
  "targetHireDate": "2025-01-15T00:00:00Z",
  "isRemote": true,
  "isHybrid": false,
  "minExperience": 6,
  "maxExperience": 10
}'

{
  "success": true,
  "data": {
    "campaignId": "123e4567-e89b-12d3-a456-426614174000",
    "step": 1,
    "status": "draft",
    "campaign": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "campaignName": "Senior Developer Hiring Q1 2024",
      "jobTitle": "Senior Software Engineer",
      "status": "draft"
    }
  },
  "message": "Job campaign Step 1 completed successfully",
  "timestamp": "2024-01-28T10:30:00.000Z",
  "version": "2.0"
}

Create job campaign - Step 1: Job Details (Required fields: campaignName, jobTitle, department, location, experienceLevel, employeeType, numberOfOpenings, jobDescription)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

campaignNamestringRequired

Campaign name (3-100 chars)

jobTitlestringRequired

Job title

departmentstringRequired

locationstringRequired

Job location

experienceLevelstringRequired

Entry Level (0–2 years)|Mid Level (3–5 years)|Senior Level (6–10 years)|Lead/Principal (10+ years)|Executive/Director (15+ years)

employeeTypestringRequired

Full-time|Part-time|Contract|Internship

numberOfOpeningsdoubleRequired

Number of openings

jobDescriptionstringRequired

Detailed job description

salaryMindoubleOptional

Minimum salary

salaryMaxdoubleOptional

Maximum salary (must be >= salaryMin)

currencystringOptional

Currency code (default: INR)

jobDutiesstringOptional

Job duties

requirementsstringOptional

Job requirements (Note: use ‘requirements’, not ‘jobRequirements’)

benefitsstringOptional

Benefits offered

skillsstringOptional

Required skills

campaignTypestringOptional

Campaign type (default: specific)

applicationDeadlinestringOptional

Application deadline (ISO 8601)

targetHireDatestringOptional

Target hire date (ISO 8601, must be >= applicationDeadline)

courseDegreestringOptional

Required degree

specializationstringOptional

Required specialization

isRemotebooleanOptional

Remote work option

isHybridbooleanOptional

Hybrid work option

minExperiencedoubleOptional

Minimum years of experience

maxExperiencedoubleOptional

Maximum years of experience

Response

Campaign step 1 created successfully

successbooleanOptional

dataobjectOptional

messagestringOptional

timestampstringOptional

versionstringOptional

Errors

400

Bad Request Error