Partner API ExplorerFulfillments
Mark a fulfillment as fulfilled
Required scope
partner:fulfillments:writePOST
Records that the member received the benefit. This is the terminal state.
header
AuthorizationBearer <token>WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.
Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected
with 401 Invalid or expired token; send it in X-API-Key instead.
WorkOS organization API keys are not accepted yet.
fulfillmentId*stringExternal fulfillment id (UUID).
Format
uuidapplication/json- body
fulfilledBy?stringnotes?stringLength
length <= 500The fulfilled claim.
application/json- response
error?stringfulfilledAt?stringstatus*stringsuccess*booleancurl -X POST 'https://api-prd.cf.journey.com/v1/partner/fulfillments/497f6eca-6276-4993-bfeb-53cbbbba6f08/fulfill' \ -H 'Content-Type: application/json' \ -d '{}'{ "error": "string", "fulfilledAt": "string", "status": "string", "success": true}