Pre-release — content may change.

Memberships

Update a membership bundle

PATCH
/membership_bundles/{id}

Updates a membership bundle. Changes to starts_at, ends_at, grace_period_days, or the organization are copied to the bundle's person memberships that have no external_id; person memberships that fall entirely outside the new date range are removed. Changing the owner moves the bundle-manager role to the new owner.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Membership bundle UUID.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/membership_bundles/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "membership_bundles",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"    }  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "type": "membership_bundles",    "attributes": {      "name_en": "string",      "name_fr": "string",      "starts_at": "2019-08-24T14:15:22Z",      "ends_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "grace_period_days": 0,      "in_grace": true,      "status": "string",      "external_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "deleted_at": "2019-08-24T14:15:22Z"    },    "relationships": {      "organization": {        "data": {          "type": "organizations",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"        },        "links": {          "self": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/organization",          "related": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/organization"        }      },      "owner": {        "data": {          "type": "people",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"        },        "links": {          "self": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/owner",          "related": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/owner"        }      },      "previous_membership_bundle": {        "data": {          "type": "membership_bundles",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"        },        "links": {          "self": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/previous_membership_bundle",          "related": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/previous_membership_bundle"        }      },      "next_membership_bundle": {        "data": {          "type": "membership_bundles",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"        },        "links": {          "self": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/next_membership_bundle",          "related": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e/next_membership_bundle"        }      }    },    "links": {      "self": "/membership_bundles/7247ad7d-9275-454b-9e3a-0570e403739e"    }  }}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}