Jump to

• Request
• Response

Update all the properties of a custom field value

put

/learn.rest/v1/memberships/{membershipId}/customFieldValues/{userCustomFieldValueId}

Request

Supported Media Types

• application/json

Path Parameters

• membershipId(required): number
  Unique identifier of Membership.
• userCustomFieldValueId(required): number
  Unique identifier of custom field.

Body ()

Custom field value object that needs to be updated

Root Schema : UserCustomFieldValueRequest

Type: object

Request object containing custom field values.

Show Source

• CustomFieldId(required): number
  Custom field unique identifier.

  Example: 354
• value(required): string
  Custom field value.

  Example: JCK

{
    "description":"Request object containing custom field values.",
    "type":"object",
    "required":[
        "CustomFieldId",
        "value"
    ],
    "properties":{
        "CustomFieldId":{
            "type":"number",
            "example":354,
            "description":"Custom field unique identifier."
        },
        "value":{
            "type":"string",
            "example":"JCK",
            "description":"Custom field value."
        }
    },
    "example":{
        "customFieldId":407,
        "value":"JCK"
    }
}

Example:

{
    "customFieldId":407,
    "value":"JCK"
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

200 Response

Resource updated.

400 Response

Request has incorrect syntax or does not contain a field that is required.

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

422 Response

Request may contain validation errors.

500 Response

Internal server error.

Back to Top