Skip to content

Changes a method's display values while preserving identity, availability and existing movements.

PUT
/api/workspace/community-memberships/payment-methods/{paymentMethodId}
curl --request PUT \
--url https://example.com/api/workspace/community-memberships/payment-methods/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "OperationId": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "DisplayName": "example", "Description": "example" }'
paymentMethodId
required
string

Stable identifier of the method.

access_token
string

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

Editable values, version read and operation identity; no reason is required.

HTTP body for editing a payment method’s display values; identity belongs to the route (UC-CM-47).

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, trimmed and unique ignoring case; at most 128 characters.

string
nullable
Description

Optional description, at most 1024 characters; blank removes it.

string
nullable
Examplegenerated
{
"OperationId": "example",
"RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"DisplayName": "example",
"Description": "example"
}

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