PApactima
Invitations

Create an invitation

Create an invitation to join the participant pool. The invitee will get an email with the link to join. If the email already has a DECLINED invitation on this pool, that invitation is revived in place (status back to PENDING, fresh token and expiry, send count reset) and re-sent; a PENDING invitation for the same email is still rejected.

post/participant-pools/{participantPoolId}/invitations

Request

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

Request body

namestring required

Name of the person being invited

emailstring required

Email address of the person being invited

rolesParticipantPoolMemberRoleEnum[] required

Roles to assign to the member when they accept the invitation

Response

Invitation created 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.