The membership profile object

A comprehensive list of the membership profile resource's attributes and relationships

A membership profile object is returned as part of the response body of each successful create, list, retrieve or update API call to the /api/membership_profiles endpoint.

Fields

Field
Type
Description

type

string

membership_profiles

id

string

The membership profile unique identifier.

links.self

string

The membership profile endpoint URL.

attributes.name

string

The membership profile name.

attributes.test_enabled

boolean

Used to enable test mode on the accessible apps.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.organization

object

The organization associated to the membership.

relationships.application_memberships

array

The application memberships associated to the membership profile.

Last updated