Skip to content

Creates an enabled membership type in the community, including its validated Entity binding.

POST
/api/workspace/community-memberships/communities/{communityId}/membership-types
curl --request POST \
--url https://example.com/api/workspace/community-memberships/communities/example/membership-types \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "OperationId": "example", "DisplayName": "example", "NumberPrefix": "example", "Kind": 0, "CorporatePaymentMode": 0, "Binding": { "PersonEntityDefinitionId": "example", "OrganizationEntityDefinitionId": "example", "RelationshipKind": 0, "ReferenceOwnerKind": 0, "ReferenceFieldId": "example", "AssociationEntityDefinitionId": "example", "PersonEndpointFieldId": "example", "OrganizationEndpointFieldId": "example" } }'
communityId
required
string

Community scope; inaccessible communities are concealed with NotFound.

access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Profile, binding and stable operation identity.

HTTP body for UC-CM-39; the route supplies the community and the SDK validates every business value.

object
OperationId

Client-chosen identity of this submission. A retry with the same identity and the same values returns the first result; the same identity with other values is rejected.

string
nullable
DisplayName

Required display name, at most 256 characters, unique within the community.

string
nullable
NumberPrefix

Optional future-number prefix, at most 32 characters.

string
nullable
Kind
integer format: int32
Allowed values: 0 1 2
CorporatePaymentMode
integer format: int32
Allowed values: 0 1
Binding

HTTP values identifying the recipients and optional corporate relationship of a membership type.

object
PersonEntityDefinitionId

Person Data definition; required for Personal and Corporate.

string
nullable
OrganizationEntityDefinitionId

Organization Data definition; required for Organization and Corporate.

string
nullable
RelationshipKind
integer format: int32
Allowed values: 0 1
ReferenceOwnerKind
integer format: int32
Allowed values: 0 1
ReferenceFieldId

Stored Reference field or its inverse selection.

string
nullable
AssociationEntityDefinitionId

Governed Association definition; required only for Association.

string
nullable
PersonEndpointFieldId

Governed Association endpoint targeting the person definition.

string
nullable
OrganizationEndpointFieldId

Distinct governed Association endpoint targeting the organization definition.

string
nullable

OK

Media typeapplication/json
object
Data

HTTP result of a Community Memberships command that creates, changes or deletes one record.

object
Id

Identifier of the created, changed or deleted record.

string
nullable
RowVersion

Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

HTTP result of a Community Memberships command that creates, changes or deletes one record.

object
Id

Identifier of the created, changed or deleted record.

string
nullable
RowVersion

Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
Data

HTTP result of a Community Memberships command that creates, changes or deletes one record.

object
Id

Identifier of the created, changed or deleted record.

string
nullable
RowVersion

Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Not Found

Media typeapplication/json
object
Data

HTTP result of a Community Memberships command that creates, changes or deletes one record.

object
Id

Identifier of the created, changed or deleted record.

string
nullable
RowVersion

Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Conflict

Media typeapplication/json
object
Data

HTTP result of a Community Memberships command that creates, changes or deletes one record.

object
Id

Identifier of the created, changed or deleted record.

string
nullable
RowVersion

Version after the command, which a later change sends back to detect concurrent changes; after a deletion, the version the record had when it was deleted.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}