Skip to main content
POST
/
v1
/
positions
Create position
curl --request POST \
  --url https://staging.api.us.aptlydone.com/settings/v1/positions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantId": "d66fa929-5f84-4780-9691-e9287cc3ae83",
  "positionName": "Senior Developer",
  "isSCIMProvisioned": false,
  "status": "ACTIVE",
  "groupIds": [
    "4441fa6b-c0f6-4843-8e34-1f9bb5914439, d0929e58-72de-41c7-889e-c0621c773958"
  ]
}'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:42.214Z",
  "message": "Success",
  "data": {
    "id": "5e30e192-a922-45d6-a35f-196c94bebd05",
    "tenantId": "b07b13fd-15ec-4d79-963c-3958a90c4f6e",
    "positionId": "10000",
    "positionName": "Senior Developer",
    "isSCIMProvisioned": false,
    "status": "ACTIVE",
    "isDeleted": false,
    "createdOn": "2025-01-13T12:34:59.300Z",
    "updatedOn": "2025-01-13T12:34:59.300Z",
    "groups": [
      {
        "groupName": "Engineering Team",
        "groupTypeName": "Organizations",
        "groupId": "52fb829d-da34-427e-a528-4d3baf5968ca",
        "groupTypeId": "e21d3dec-fa12-48ea-b800-71faa767394c",
        "parentId": 2,
        "parentName": "Technology Division",
        "createdAt": "2025-01-13T12:34:59.303Z",
        "updatedAt": "2025-01-13T12:34:59.303Z"
      }
    ],
    "delegationsReceived": 1,
    "delegationsIssued": 1
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
tenantId
string
required

Tenant ID

Example:

"d66fa929-5f84-4780-9691-e9287cc3ae83"

​
positionName
string
required

Position name

Example:

"Senior Developer"

​
isSCIMProvisioned
boolean

SCIMP provisioned flag

Example:

false

​
status
enum<string>
default:ACTIVE

Status

Available options:
ACTIVE,
INACTIVE
​
groupIds
string[]

Group IDs

Example:
[
  "4441fa6b-c0f6-4843-8e34-1f9bb5914439, d0929e58-72de-41c7-889e-c0621c773958"
]

Response

201 - application/json

Position created successfully

​
statusCode
number
required

HTTP Status code

Example:

200

​
timestamp
string
required

Timestamp of the response

Example:

"2025-06-24T08:51:42.214Z"

​
message
string
required

Response message

Example:

"Success"

​
data
object
required

Response data