PApactima
Items - Actions

Set on-demand match notice phone number

Set the phone number used to notify the schedule setter participant when an on-demand match is found.

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

post/participant-pools/{participantPoolId}/items/{id}/actions/set-on-demand-match-notice-phone-number

Request

  • Base URL
    https://rest.api.pactima.com/v1
  • URL
    https://rest.api.pactima.com/v1/participant-pools/{participantPoolId}/items/{id}/actions/set-on-demand-match-notice-phone-number
  • Auth
    HTTP bearer

Request body

onDemandMatchNoticePhoneNumberstring required

Phone number to notify the signer when an on-demand match is found

Response

Phone number 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.