boldsign.CustomFieldApi

All URIs are relative to https://api.boldsign.com

Method	HTTP request	Description
create_custom_field	POST /v1/customField/create	Create the custom field.
custom_fields_list	GET /v1/customField/list	List the custom fields respective to the brand id.
delete_custom_field	DELETE /v1/customField/delete	Delete the custom field.
edit_custom_field	POST /v1/customField/edit	Edit the custom field.
embed_custom_field	POST /v1/customField/createEmbeddedCustomFieldUrl	Generates a URL for creating or modifying custom fields within your application's embedded Designer.

create_custom_field

CustomFieldMessage create_custom_field(brand_custom_field_details)

Create the custom field.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.brand_custom_field_details import BrandCustomFieldDetails
from boldsign.models.custom_field_message import CustomFieldMessage
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.CustomFieldApi(api_client)
    brand_custom_field_details = boldsign.BrandCustomFieldDetails() # BrandCustomFieldDetails | The custom field details.

    try:
        # Create the custom field.
        api_response = api_instance.create_custom_field(brand_custom_field_details)
        print("The response of CustomFieldApi->create_custom_field:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomFieldApi->create_custom_field: %s\n" % e)

Parameters

Name	Type	Description	Notes
brand_custom_field_details	BrandCustomFieldDetails	The custom field details.

Return type

CustomFieldMessage

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

custom_fields_list

CustomFieldCollection custom_fields_list(brand_id)

List the custom fields respective to the brand id.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.custom_field_collection import CustomFieldCollection
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.CustomFieldApi(api_client)
    brand_id = 'brand_id_example' # str | The brand id.

    try:
        # List the custom fields respective to the brand id.
        api_response = api_instance.custom_fields_list(brand_id)
        print("The response of CustomFieldApi->custom_fields_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomFieldApi->custom_fields_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
brand_id	str	The brand id.

Return type

CustomFieldCollection

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_custom_field

DeleteCustomFieldReply delete_custom_field(custom_field_id)

Delete the custom field.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.delete_custom_field_reply import DeleteCustomFieldReply
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.CustomFieldApi(api_client)
    custom_field_id = 'custom_field_id_example' # str | The custom field id.

    try:
        # Delete the custom field.
        api_response = api_instance.delete_custom_field(custom_field_id)
        print("The response of CustomFieldApi->delete_custom_field:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomFieldApi->delete_custom_field: %s\n" % e)

Parameters

Name	Type	Description	Notes
custom_field_id	str	The custom field id.

Return type

DeleteCustomFieldReply

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_custom_field

CustomFieldMessage edit_custom_field(custom_field_id, brand_custom_field_details)

Edit the custom field.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.brand_custom_field_details import BrandCustomFieldDetails
from boldsign.models.custom_field_message import CustomFieldMessage
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.CustomFieldApi(api_client)
    custom_field_id = 'custom_field_id_example' # str | The custom field id.
    brand_custom_field_details = boldsign.BrandCustomFieldDetails() # BrandCustomFieldDetails | The custom field details.

    try:
        # Edit the custom field.
        api_response = api_instance.edit_custom_field(custom_field_id, brand_custom_field_details)
        print("The response of CustomFieldApi->edit_custom_field:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomFieldApi->edit_custom_field: %s\n" % e)

Parameters

Name	Type	Description	Notes
custom_field_id	str	The custom field id.
brand_custom_field_details	BrandCustomFieldDetails	The custom field details.

Return type

CustomFieldMessage

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

embed_custom_field

EmbeddedCustomFieldCreated embed_custom_field(brand_id, link_valid_till=link_valid_till)

Generates a URL for creating or modifying custom fields within your application's embedded Designer.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.embedded_custom_field_created import EmbeddedCustomFieldCreated
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.CustomFieldApi(api_client)
    brand_id = 'brand_id_example' # str | The Brand ID for custom fields must be configured
    link_valid_till = '2013-10-20T19:20:30+01:00' # datetime | This property is used to set the validity of the generated URL. Its maximum validity is 30 days (optional)

    try:
        # Generates a URL for creating or modifying custom fields within your application's embedded Designer.
        api_response = api_instance.embed_custom_field(brand_id, link_valid_till=link_valid_till)
        print("The response of CustomFieldApi->embed_custom_field:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CustomFieldApi->embed_custom_field: %s\n" % e)

Parameters

Name	Type	Description	Notes
brand_id	str	The Brand ID for custom fields must be configured
link_valid_till	datetime	This property is used to set the validity of the generated URL. Its maximum validity is 30 days	[optional]

Return type

EmbeddedCustomFieldCreated

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CustomFieldApi.md

Latest commit

History

CustomFieldApi.md

File metadata and controls

boldsign.CustomFieldApi

create_custom_field

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

custom_fields_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_custom_field

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

edit_custom_field

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

embed_custom_field

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details