Skip to content

Membership Plan - Extras - Add additional field

POST
/internal/v2/{bucket}/membership_type/{uid}/extras/additional_field

Add an additional user input field to a membership plan

bucket
required

The bucket (client) name

string
Example
example
uid
required

Usually the final element in the URI, an alphanumeric unique identifier

string
Example
6305f074683e800f3abe809e
label
required

The label for the field that will be shown to the user

string
field

The field name, if not provided the label will be slugified

string
description
required

A description of the field, shown to the user

string
form_type
required

The type of field

string
Allowed values: checkbox date email multi-choice number person_record select tel text textarea
required

Is this field required?

boolean
options

If the form_type is select, this is the list of options that will be shown to the user

Array<string>
dob_required

If the form_type is person_record, is the date of birth required?

boolean

Successful operation

A standard error message

object
description

A human readable description of the error

string
error

A concise error message

string
type

A machine readable error type

string

Unauthorized is the status code to return when the client provides no credentials or invalid credentials.

Forbidden is the status code to return when a client has valid credentials but not enough privileges to perform an action on a resource.

Not found

An error occurred within sheepCRM, please report to support@sheepcrm.com