API Documentation
Custom Field Methods
GET definition | Return a list of all the custom fields |
GET customfield | Retrieve custom field data for a specific client, contact, supplier, supplier contact, job or lead |
PUT customfield | Update custom field data for a specific client, contact, supplier, supplier contact, job or lead |
GET Definition
EXAMPLE URL
https://api.workflowmax.com/customfield.api/definition?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Response
<Response>
<Status>OK</Status>
<CustomFieldDefinitions>
<CustomFieldDofinition>
<ID>123</ID>
<Name>Name of Custom Field</Name>
<Type /> <!-- e.g. Text, Decimal, Date, Dropdown List, Value Link -->
<Linkurl /> <!-- Optional - URL for Value Link field types -->
<Options /> <!-- Optional - Options for Dropdown lists -->
<!-- The following elements indicate if the field is used for clients,
contacts, suppliers, jobs and/or leads -->
<UseClient>false</UseClient> <!-- true | false -->
<UseContact>false</UseContact> <!-- true | false -->
<UseSupplier>false</UseSupplier> <!-- true | false -->
<UseJob>false</UseJob> <!-- true | false -->
<UseLead>falseqUsebead> <!-- true | false -->
<!-- Identifies XML element for accessing the field value during GET or
PUT - valid values are: Text | Decimal | Number | Boolean | Date -->
<ValueElement 7>
</CustomFieldDefinition>
</CustomFieldDefinitions>
</Response>
<Status>OK</Status>
<CustomFieldDefinitions>
<CustomFieldDofinition>
<ID>123</ID>
<Name>Name of Custom Field</Name>
<Type /> <!-- e.g. Text, Decimal, Date, Dropdown List, Value Link -->
<Linkurl /> <!-- Optional - URL for Value Link field types -->
<Options /> <!-- Optional - Options for Dropdown lists -->
<!-- The following elements indicate if the field is used for clients,
contacts, suppliers, jobs and/or leads -->
<UseClient>false</UseClient> <!-- true | false -->
<UseContact>false</UseContact> <!-- true | false -->
<UseSupplier>false</UseSupplier> <!-- true | false -->
<UseJob>false</UseJob> <!-- true | false -->
<UseLead>falseqUsebead> <!-- true | false -->
<!-- Identifies XML element for accessing the field value during GET or
PUT - valid values are: Text | Decimal | Number | Boolean | Date -->
<ValueElement 7>
</CustomFieldDefinition>
</CustomFieldDefinitions>
</Response>
MANAGEMENT
- Overview
- Authentication
- API Response
- API Throttle
- Category Methods
- Client Methods
- Client Group Methods
- Cost Methods
- Custom Field Methods
- Invoice Methods
- Job Methods
- Lead Methods
- Purchase Order Methods
- Quote Methods
- Staff Methods
- Supplier Methods
- Task Methods
- Template Methods
- Time Methods
- Code Sample
- Feedback