POST/jds

Create Job Description

Create a new JD in DRAFT status. Use the dashboard or API to publish it later.

🔒 Scope required: write or jd:write

Body Parameters

Parameter	Type	Required	Description
`title`	string	✅	Job title
`description`	string	✅	Full job description text
`createdById`	string	✅	User ID of the creator
`department`	string	No	Department name
`location`	string	No	Job location
`experience`	string	No	Required experience (e.g. “5-8 years”)
`type`	string	No	Employment type. Default: `"full-time"`
`salary`	string	No	Salary range
`requirements`	string	No	Key requirements / skills

Example

curl -X POST https://api.scootsign.com/api/v1/jds \
  -H "X-API-Key: aram_ent_a1b2c3d4e5f6..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Senior Backend Engineer",
    "description": "Build scalable APIs with Node.js and TypeScript...",
    "department": "Engineering",
    "location": "Remote",
    "experience": "5-8 years",
    "type": "full-time",
    "salary": "₹25-35 LPA",
    "requirements": "Node.js, TypeScript, PostgreSQL",
    "createdById": "user_abc123"
  }'

Response

{
  "success": true,
  "data": {
    "id": "jd_new123",
    "title": "Senior Backend Engineer",
    "status": "DRAFT"
  }
}

JDs are created in DRAFT status. Use the Aram dashboard to review and publish them, which makes them visible on your candidate portal.