Jump to

• Request
• Response

Create a new custom Field Value.

post

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

Request

Supported Media Types

• application/json

Path Parameters

• membershipId: number
  Unique identifier of a Membership.

Body ()

Custom Field Value object that needs to be created.

Root Schema : CustomFieldValueRequest

Type: object

Request object comprising a custom field and it's values.

Show Source

• customFieldId: number
  Unique identifier for the custom field.

  Example: 407
• value: string
  Custom field values.

  Example: JCK

{
    "description":"Request object comprising a custom field and it's values.",
    "type":"object",
    "required":[
        "customFieldId",
        "value"
    ],
    "properties":{
        "customFieldId":{
            "description":"Unique identifier for the custom field.",
            "type":"number",
            "example":407
        },
        "value":{
            "description":"Custom field values.",
            "type":"string",
            "example":"JCK"
        }
    },
    "example":{
        "customFieldId":407,
        "value":"JCK"
    }
}

Example:

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

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

201 Response

New custom Field Value created.

Body

Example Response (application/json)

{
    "id":"1",
    "customFieldId":"456",
    "customField":{
        "links":[
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/learnCenters/123/userCustomFields/456"
            }
        ]
    },
    "value":"User Custom Field Value",
    "links":[
        {
            "rel":"canonical",
            "href":"{url}/learn.rest/v1/learnCenters/456/userCustomFields/1"
        }
    ]
}

400 Response

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

409 Response

Another resource with the same identifier already exists.

500 Response

Internal server error.

Back to Top