Edits a type's name and prefix, preserving its identity, kind, payer, binding and availability.

PUT

/api/workspace/community-memberships/communities/{communityId}/membership-types/{membershipTypeId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/community-memberships/communities/example/membership-types/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"OperationId\": \"example\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"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\" } }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/community-memberships/communities/example/membership-types/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"OperationId":"example","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","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"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/workspace/community-memberships/communities/example/membership-types/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "OperationId": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "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" } }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

communityId

required

string

Owning community; inaccessible communities are concealed with NotFound.

membershipTypeId

required

string

Stable identity of the type within the community.

Query Parameters

access_token

string

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

Request Body

Complete profile, version read and operation identity; no reason is required.

HTTP body for UC-CM-40; the route supplies community/type IDs and access precedes value validation.

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

RowVersion

Version the client read; missing and stale versions are rejected.

string format: uuid

nullable

DisplayName

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

string

nullable

NumberPrefix

Optional future-number prefix, at most 32 characters; blank removes it.

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

Responses

200

application/json

object

Data

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

object

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
    }
  ]
}

400

Bad Request

application/json

object

Data

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

object

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
    }
  ]
}

403

Forbidden

application/json

object

Data

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

object

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
    }
  ]
}

404

Not Found

application/json

object

Data

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

object

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
    }
  ]
}

409

Conflict

application/json

object

Data

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

object

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
    }
  ]
}