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 |
Use the following URLs to retrieve custom field data:
Client | GET https://api.workflowmax.com/client.api/get/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Contact | GET https://api.workflowmax.com/client.api/contact/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Supplier | GET https://api.workflowmax.com/supplier.api/get/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Supplier Contact | GET https://api.workflowmax.com/supplier.api/contact/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Job | GET https://api.workflowmax.com/job.api/get/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Job Task | GET https://api.workflowmax.com/job.api/task/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Job Cost | GET https://api.workflowmax.com/job.api/cost/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Time | GET https://api.workflowmax.com/time.api/get/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Lead | GET https://api.workflowmax.com/lead.api/get/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Only custom fields containing values will be returned. If a Checkbox field does not contain a value then it is assumed to be false.
Use the following URLs to set/update custom field data:
Client | PUT https://api.workflowmax.com/client.api/update/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Contact | PUT https://api.workflowmax.com/client.api/contact/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Supplier | PUT https://api.workflowmax.com/supplier.api/update/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Supplier Contact | PUT https://api.workflowmax.com/supplier.api/contact/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Job | PUT https://api.workflowmax.com/job.api/update/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Job Task | PUT https://api.workflowmax.com/job.api/task/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Job Cost | PUT https://api.workflowmax.com/job.api/cost/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Time | PUT https://api.workflowmax.com/time.api/update/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Lead | PUT https://api.workflowmax.com/lead.api/update/[id]/customfield?apiKey=[your API key]&accountKey=[WorkflowMax account key] |
Only custom fields containing values will be returned. If a Checkbox field does not contain a value then it is assumed to be false.
The response will be the standard API Response.