Create a membership profile

How to create a membership profile via API

To create a new membership profile, send a POST request to the /api/membership_profiles endpoint, passing the resource arguments in the request body.

Request

POST https://provisioning.commercelayer.io/api/membership_profiles

Arguments

Body Parameter
Type
Required

type

string

Required

attributes.name

string

Required

attributes.test_enabled

boolean

Required

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.organization

object

Required

relationships.application_memberships

array

Optional

Example

The following request creates a new membership profile:

curl -g -X POST \
  'https://provisioning.commercelayer.io/api/membership_profiles' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "membership_profiles",
    "attributes": {
      "name": "Marketing group",
      "test_enabled": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Last updated