PApactima
Items - Actions

Set availabilities for a pool item

Set the availabilities for a participant pool item. This action is performed by the participant designated as a schedule setter (scheduling.scheduleSetterParticipantsIds), authenticated via the participant pool schedule setter token.

The provided availabilities replace any previously set availabilities on the item.

post/participant-pools/{participantPoolId}/items/{id}/actions/set-availabilities

Request

  • Base URL
    https://rest.api.pactima.com/v1
  • URL
    https://rest.api.pactima.com/v1/participant-pools/{participantPoolId}/items/{id}/actions/set-availabilities
  • Auth
    HTTP bearer

Request body

switchToPrescheduledboolean

When true, switches the item's scheduling mode from ON_DEMAND to PRE_SCHEDULED. Only applicable to items with ON_DEMAND scheduling mode.

Response

Availabilities set successfully. Returns the updated pool item.

idstring

Unique identifier for the participant pool item

participantPoolIdstring required

ID of the participant pool this item belongs to

status'DRAFT' | 'AWAITING_TAGGING' | 'AWAITING_PARTICIPANT_PREFERENCE' | 'REQUEST_SENT_TO_ENROLLEES' | 'MATCHED' | 'STALE' | 'CANCELLED' | 'COMPLETED' required

Current status of a participant pool item

Changes

No recorded changes to this operation across all 1 revision of this API.