PApactima
Invitations

Update an invitation

Update an existing invitation's details. Only a PENDING invitation can be updated; a DECLINED invitation is rejected (re-invite it via create instead).

put/participant-pools/{participantPoolId}/invitations/{id}

Request

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

Request body

namestring

Updated name of the person being invited

emailstring

Updated email address of the person being invited

rolesParticipantPoolMemberRoleEnum[]

Updated roles to assign to the member when they accept the invitation

Response

Invitation updated successfully

idstring

Unique identifier for the invitation

namestring required

Name of the person being invited

emailstring required

Email address of the person being invited

rolesParticipantPoolMemberRoleEnum[] required

Roles that will be assigned to the member when they accept the invitation

status'PENDING' | 'DECLINED'

Lifecycle status of a participant pool invitation. Absent on invitations created before this field existed; consumers must treat a missing value as PENDING.

createdAtstring date-time

Timestamp when the invitation was created

expiresAtstring date-time

Timestamp when the invitation expires

declinedAtstring date-time

Timestamp when the invitation was declined. Present only while status is DECLINED; cleared when the decline is undone or the invitation is revived by a re-invite.

Changes

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