Create Campaign - Step 4 | Gradii API Documentation

curl -X POST https://gradii.ai/api/v2/job-campaigns/create/step4 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "campaignId": "123e4567-e89b-12d3-a456-426614174000",
  "publishImmediately": true,
  "generateJobPostings": false,
  "sendNotifications": true,
  "notes": "Campaign ready for Q1 2024 hiring",
  "tags": [
    "urgent",
    "senior-role",
    "remote"
  ],
  "validateSetup": true
}'

{
  "success": true,
  "data": {
    "campaignId": "123e4567-e89b-12d3-a456-426614174000",
    "step": 4,
    "status": "completed",
    "campaign": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "campaignName": "Senior Developer Hiring Q1 2024",
      "jobTitle": "Senior Software Engineer",
      "status": "active",
      "numberOfOpenings": 3,
      "createdAt": "2024-01-28T10:00:00.000Z",
      "updatedAt": "2024-01-28T10:30:00.000Z"
    },
    "setup": {
      "interviewRounds": 1,
      "scoringParameters": 5,
      "autoSchedulingEnabled": true
    },
    "validationResults": {
      "isValid": true,
      "warnings": [],
      "errors": []
    },
    "nextSteps": [
      {
        "action": "manage_candidates",
        "description": "Review applications and manage your candidate pipeline",
        "url": "/dashboard/job-campaign/123e4567/candidates"
      },
      {
        "action": "schedule_interviews",
        "description": "Set up interviews with qualified candidates",
        "url": "/dashboard/job-campaign/123e4567/interviews"
      },
      {
        "action": "track_progress",
        "description": "Monitor campaign performance and analytics",
        "url": "/dashboard/job-campaign/123e4567/analytics"
      }
    ]
  },
  "message": "Job campaign created successfully! Campaign is now live and accepting applications.",
  "timestamp": "2024-01-28T10:30:00.000Z",
  "version": "2.0"
}

Create job campaign - Step 4: Complete & Publish (Finalize and optionally publish the campaign)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

campaignIdstringRequiredformat: "uuid"

Campaign ID from Step 1

publishImmediatelybooleanOptional

Publish campaign immediately (sets status to ‘active’, default: false)

generateJobPostingsbooleanOptional

Generate job postings (default: false)

sendNotificationsbooleanOptional

Send notifications (default: true)

notesstringOptional

Additional notes

tagslist of anyOptional

Campaign tags

validateSetupbooleanOptional

Validate setup before completion (default: true)

Response

Campaign created successfully

successbooleanOptional

dataobjectOptional

messagestringOptional

timestampstringOptional

versionstringOptional

Errors

400

Bad Request Error