ContactCustomField Object

The following API calls are currently available for the ContactCustomField object:

GET LIST - Get a list of all of your contact custom fields.

https://api.alchemer.com/v5/contactcustomfield

Note: Get requests will cache for 60 seconds. If you make repeated API get requests that are identical, the return will be cached and will thus return identical results.
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
pagepage=3False
resultsperpageresultsperpage=100False

Response Example (.json format):

{
    "result_ok": true,
    "data": {
        "1": {
            "id": "1",
            "name": "customer_id",
            "type": "Number"
        },
        "2": {
            "id": "2",
            "name": "subscription_type",
            "type": "Text"
        },
        "3": {
            "id": "3",
            "name": "renewal_date",
            "type": "Date/Time"
        }
    }
}

GET CONTACTCUSTOMFIELD - Get information about a specific contact custom field.

https://api.alchemer.com/v5/contactcustomfield/1

Note: Get requests will cache for 60 seconds. If you make repeated API get requests that are identical, the return will be cached and will thus return identical results.
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
pagepage=3False
resultsperpageresultsperpage=100False

Response Example (.json format):

{
    "result_ok": true,
    "data": {
        "id": "1",
        "name": "customer_id",
        "type": "Number"
    }
}

CREATE CONTACTCUSTOMFIELD- Create a new contact custom field.

https://api.alchemer.com/v5/contactcustomfield?_method=PUT&name=customfield&type=Text

ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
nameContact Custom Field Name (e.g. Customer ID)True
type*Text, Date/Time, Currency, Number, Yes/NoFalse

*type will default to Text if not specified

Response Example (.json format):

{
    "result_ok": true,
    "data": {
        "id": "6",
        "name": "plan_type",
        "type": "Text"
    }
}

CHANGE/UPDATE/ADD TO CONTACTCUSTOMFIELD- Update your contact custom field.

https://api.alchemer.com/v5/contactcustomfield/1?_method=POST&name=updatedname&type=Text

ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
nameContact Custom Field Name (e.g. Customer ID)
True
type*Text, Date/Time, Currency, Number, Yes/No
False

*type will default to Text if not specified

Response Example (.json format):

{
    "result_ok": true,
    "data": {
        "id": "6",
        "name": "updatethisfield",
        "type": "Text"
    }
}

DELETE CONTACTCUSTOMFIELD - Delete a contact custom field.

https://api.alchemer.com/v5/contactcustomfield/1?_method=DELETE

ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True

Response Example (.json format):

{
    "result_ok": true
}