Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
allocation

Update an allocation by record id

patch/v1/org/{orgId}/allocation/{allocationId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

allocationIdstring required

Allocation id

Request body

allocationnumber

portion of the job's capacity allocated to the group, as a decimal (0.25 means 25%)

effectiveDatestring date

first date this allocation applies

endDatestring date

last date this allocation applies, or null if it is open-ended

notesstring

free-text note about this allocation

derivedFromTeamAllocationboolean

true when this record was derived by dividing a team-level allocation across team members

Response

updated

totalAllocationnumber required
warningsstring[] required

Example response

{
  "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"
  }
}