Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
allocation

Create or update allocations to a group, keyed on (jobId, groupId, effectiveDate)

post/v1/org/{orgId}/allocation/group/{groupId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

groupIdstring required

Group id the allocations are for

Request body

jobIdstring required
allocationnumber required
effectiveDatestring date required
endDatestring date
notesstring
derivedFromTeamAllocationboolean

Example request

[
  {
    "jobId": "588f7ee98f138b19220041a7"
  }
]

Response

ok -- inspect each row's result

Example response

{
  "results": [
    {
      "jobId": "588f7ee98f138b19220041a7",
      "allocation": {
        "id": "588f7ee98f138b19220041a7",
        "orgId": "588f7ee98f138b19220041a7",
        "jobId": "588f7ee98f138b19220041a7",
        "groupId": "588f7ee98f138b19220041a7",
        "groupTypeId": "588f7ee98f138b19220041a7",
        "createId": "588f7ee98f138b19220041a7",
        "createBehalfId": "588f7ee98f138b19220041a7",
        "createAttribution": {
          "principalUserId": "588f7ee98f138b19220041a7",
          "agentUserIds": [
            "588f7ee98f138b19220041a7"
          ],
          "eventId": "588f7ee98f138b19220041a7",
          "aiChatId": "588f7ee98f138b19220041a7"
        },
        "createAt": "2017-01-24T13:57:52Z",
        "updateId": "588f7ee98f138b19220041a7",
        "updateBehalfId": "588f7ee98f138b19220041a7",
        "updateAttribution": {
          "principalUserId": "588f7ee98f138b19220041a7",
          "agentUserIds": [
            "588f7ee98f138b19220041a7"
          ],
          "eventId": "588f7ee98f138b19220041a7",
          "aiChatId": "588f7ee98f138b19220041a7"
        },
        "updateAt": "2017-01-24T13:57:52Z",
        "deleteId": "588f7ee98f138b19220041a7",
        "deleteBehalfId": "588f7ee98f138b19220041a7",
        "deleteAttribution": {
          "principalUserId": "588f7ee98f138b19220041a7",
          "agentUserIds": [
            "588f7ee98f138b19220041a7"
          ],
          "eventId": "588f7ee98f138b19220041a7",
          "aiChatId": "588f7ee98f138b19220041a7"
        },
        "deleteAt": "2017-01-24T13:57:52Z"
      }
    }
  ]
}