Partners Me Activities

Submit a new partner activity for VXP review

Changed on
post/v1/partners/me/activities

Request

Request body

vxpAwardIdstring uuid required
scope'PERSONAL' | 'BUSINESS' required
titlestring required
descriptionstring nullable
evidenceUrlstring nullable

Evidence URL

activityDatestring date-time required

When the activity happened (cannot be in the future)

clientNamestring nullable
clientUrlstring nullable

Client URL

projectDescriptionstring nullable
submittedByIdstring uuid

Local workos_user.id of the member to credit. Owner/admin only.

Response

idstring uuid required
vxpAwardIdstring uuid required
scope'PERSONAL' | 'BUSINESS' required
status'PENDING' | 'APPROVED' | 'AUTO_APPROVED' | 'REJECTED' | 'CANCELLED' required
source'MANUAL' | 'GITHUB_BOT' required
titlestring required
descriptionstring nullable required
evidenceUrlstring nullable required
baseVxpinteger required
awardedVxpinteger nullable required
currentVxpinteger required
activityDatestring date-time required
reviewerNotesstring nullable required
decisionReasonstring nullable required
reviewedAtstring date-time nullable required
clientNamestring nullable required
clientUrlstring nullable required
projectDescriptionstring nullable required
createdAtstring date-time required
submittedByIdstring uuid required
loggedByIdstring uuid nullable required
loggedByNamestring nullable required

Changes

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status