Update an enrollment
/users/{user_id}/enrollments/{enrollment_id}Updates the status or scheduled end of an enrollment, or restores a revoked enrollment.
Setting status to revoked or deleted to false requires the enrollments.delete permission in addition to enrollments.update. Only manually granted enrollments can be revoked or restored; enrollments originating from a sale or subscription return state_conflict.
ends_at must be an ISO 8601 date-time with a time zone offset. Send null to remove the scheduled end.
To avoid overwriting a newer version, send the ETag returned by the retrieve operation in the If-Match header.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/users/string/enrollments/string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "created_at": "2019-08-24T14:15:22Z", "deleted": true, "delivery_id": "string", "ends_at": "2019-08-24T14:15:22Z", "id": "string", "object": "enrollment", "origin": { "kind": "manual", "sale_id": "string", "subscription_id": "string" }, "product_ids": [ "string" ], "revision": "string", "status": "active", "subscription_ends_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string" }}