is now

API-Documentation II

Last update: June 27, 2025

Picture of Sharan Murali
Sharan Murali

Technical Writer

In this article:

Some of the most powerful features in servis.ai exist in a low-code environment.  The coding process is quick and easy! You’ll need full access to our API and/or refer to the use-case tutorials in this Knowledge Base with copy-and-paste code to hit the ground running.

With servis.ai API you can do everything in servis.ai CRM’s Web Interface allowing you to interact with other applications (API stands for Application Programming Interface).

Through the GraphQL API you can perform any typical CRUD operations (create, read, update, delete) on any of your Apps whether they are our out-of-the-box Apps such as Contacts, Deals, Accounts, Tasks, or any Custom App you create. You can create Notes or Tasks as well!

Unleash the power of Servis.ai APIs with our curated collection of requests for Postman! This collection provides a valuable starting point for exploring various APIs. If you are new to Postman? No worries! Before diving in, we recommend checking out Postman’s basic documentation to get comfortable with the tool.

Ready to Get Started? Click here to download the Servis.ai Postman collection and unlock the full potential of Servis.ai APIs!

List Changes on App Records

Get a list of the latest changes made to a record.

GraphQL Parameters

Parameter GraphQL Type Description
entity String In order to know the entity object name, you can consult the object name in your Apps configuration.

Required

id String The id must be the UUID record id. In order to know the id of a record you can use the endpoint listEntityValues

Required

from_date Date The format can be YYYY-MM-DD or ISO Date YYYY-MM-DD:HH:MM:SS.000z
to_date Date The format can be YYYY-MM-DD or ISO Date YYYY-MM-DD:HH:MM:SS.000z
limit Int Limit the number of results returned by the query.
offset Int Page offset of the results returned, used along with limit to paginate results

Example Request

query fetchChangeHistory($entity: String!, $id: String, $entity_id: String, $from_date: Date, $to_date: Date, $offset: Int, $limit: Int, $fields: [String]) {
fetchChangeHistory(entity: $entity, id: $id, entity_id: $entity_id, from_date: $from_date, to_date: $to_date, offset: $offset, limit: $limit, fields: $fields) {
record_changes {
seq_id
instance_id
is_create
created_at
created_by
updated_at
updated_by
field_changes
updated_by_job
job_detail
}
}
}

Example Variables

{
"entity": "contact",
"id": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
"from_date": "2015-01-01T00:00:00.000Z",
"to_date": "2030-01-01T23:59:00.000Z",
"offset": 0,
"limit": 100
}

Example Response

{
    "data": {
        "fetchChangeHistory": {
            "record_changes": [
                {
                    "seq_id": "CON101751",
                    "instance_id": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                    "is_create": false,
                    "created_at": {
                        "id": "e29cfaf5-accd-41dc-a6fd-fcf26329d941",
                        "value": "2022-05-25T12:57:48.287Z",
                        "instanceId": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                        "display_value": "2022-05-25T12:57:48.287Z",
                        "formatted_value": "2022-05-25T12:57:48.287Z",
                        "type": "DateTimeComplete",
                        "metadata": null
                    },
                    "created_by": {
                        "id": "cab5f807-33e0-4ddf-9207-e48f6c039ae1",
                        "value": "d33b9d0c-1b5d-4ae6-a3e0-87f6e83c6f1d",
                        "instanceId": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                        "display_value": "Jamie Oliver",
                        "formatted_value": "Jamie Oliver",
                        "type": "reference",
                        "metadata": {
                            "full_name": "Jamie Oliver",
                            "first_name": "Jamie",
                            "last_name": "Oliver",
                            "portrait_url": null,
                            "email_address": "jamieoliver@gmail.com",
                            "extra_info": true,
                            "id": "d33b9d0c-1b5d-4ae6-a3e0-87f6e83c6f1d",
                            "display_name": "Jamie Oliver",
                            "deleted": false
                        }
                    },
                    "updated_at": {
                        "id": "3a746264-61c3-4955-b649-c37b96cddccb",
                        "value": "2024-09-10T18:06:27.007Z",
                        "instanceId": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                        "display_value": "2024-09-10T18:06:27.007Z",
                        "formatted_value": "2024-09-10T18:06:27.007Z",
                        "type": "DateTimeComplete",
                        "metadata": null
                    },
                    "updated_by": {
                        "id": "cab5f807-33e0-4ddf-9207-e48f6c039ae1",
                        "value": "d33b9d0c-1b5d-4ae6-a3e0-87f6e83c6f1d",
                        "instanceId": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                        "display_value": "Jamie Oliver",
                        "formatted_value": "Jamie Oliver",
                        "type": "reference",
                        "metadata": {
                            "full_name": "Jamie Oliver",
                            "first_name": "Jamie",
                            "last_name": "Oliver",
                            "portrait_url": null,
                            "email_address": "jamieoliver@gmail.com",
                            "extra_info": true,
                            "id": "d33b9d0c-1b5d-4ae6-a3e0-87f6e83c6f1d",
                            "display_name": "Jamie Oliver",
                            "deleted": false
                        }
                    },
                    "field_changes": [
                        {
                            "changed_field": {
                                "formatted_value": "Last Status Change Date",
                                "display_value": "Last Status Change Date",
                                "value": "contact_field2"
                            },
                            "current_value": {
                                "id": "6cf8c73b-a9f1-4063-bf87-0ab1da163f03",
                                "value": "2024-09-10T18:06:26.997Z",
                                "instanceId": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                                "display_value": "2024-09-10T18:06:26.997Z",
                                "formatted_value": "2024-09-10T18:06:26.997Z",
                                "type": "DateTimeComplete",
                                "metadata": null
                            },
                            "previous_value": {
                                "id": "6cf8c73b-a9f1-4063-bf87-0ab1da163f03",
                                "value": "2023-05-26T11:36:57.927Z",
                                "instanceId": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                                "display_value": "2023-05-26T11:36:57.927Z",
                                "formatted_value": "2023-05-26T11:36:57.927Z",
                                "type": "DateTimeComplete",
                                "metadata": null
                            }
                        },
                        {
                            "changed_field": {
                                "formatted_value": "Lead Status",
                                "display_value": "Lead Status",
                                "value": "lead_status_id"
                            },
                            "current_value": {
                                "id": "b24b967e-5403-4c60-ae7d-daaf295a1593",
                                "value": "01788c1f-f030-4f72-baad-a2bc27f13840",
                                "instanceId": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                                "display_value": "Qualified",
                                "formatted_value": "Qualified",
                                "user_defined_value": null,
                                "type": "reference",
                                "metadata": {
                                    "custom_fields": {
                                        "color": "#329288"
                                    },
                                    "user_defined_value": null,
                                    "extra_info": true,
                                    "id": "01788c1f-f030-4f72-baad-a2bc27f13840",
                                    "display_name": "Qualified",
                                    "deleted": false,
                                    "catalog_type.id": "9847708a-71b5-460d-b5ee-b0324a309ff2",
                                    "catalog_type.name": "Lead Status - Lead",
                                    "catalog_type.deleted": false,
                                    "catalog_type.metadata": null
                                }
                            },
                            "previous_value": {
                                "id": "b24b967e-5403-4c60-ae7d-daaf295a1593",
                                "value": "04d022b9-c405-427d-b1c2-0295a337d34c",
                                "instanceId": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                                "display_value": "Connected",
                                "formatted_value": "Connected",
                                "user_defined_value": null,
                                "type": "reference",
                                "metadata": {
                                    "custom_fields": {
                                        "color": "#52b0a4"
                                    },
                                    "user_defined_value": null,
                                    "extra_info": true,
                                    "id": "04d022b9-c405-427d-b1c2-0295a337d34c",
                                    "display_name": "Connected",
                                    "deleted": false,
                                    "catalog_type.id": "9847708a-71b5-460d-b5ee-b0324a309ff2",
                                    "catalog_type.name": "Lead Status - Lead",
                                    "catalog_type.deleted": false,
                                    "catalog_type.metadata": null
                                }
                            }
                        }
                    ],
                    "updated_by_job": {
                        "id": "671e182f-edd7-403d-94f9-dd94a282b89b",
                        "value": null,
                        "instanceId": "8f721091-5b4a-4af1-882c-8aea3cf891e6",
                        "display_value": null,
                        "formatted_value": null,
                        "type": "bot_job_info",
                        "metadata": null
                    },
                    "job_detail": {
                        "is_job_run": false
                    }
                },
            ]
        }
    }
}

List Account Users

Get a list of all users in your account, this list contains valuable information such as full name, email address, access level and more.

 

GraphQL Parameters

Parameter GraphQL Type Description
limit Int Limit the number of results returned by the query.
offset Int Page offset of the results returned, used along with limit to paginate results

 

Example Request

query getTeamMembers {
getTeamMembers {
agents {
id
full_name
first_name
last_name
job_title
signature
presence
teamId
email_address
access_level
access_level_option
language
language_iso
version
phone
last_activity
timezone
network_status
status
deleted
blacklisted
is_visible
pair_email
}
}
}

Example Variables

{
"limit": 50,
"offset": 0
}

Example Response

[
{
"data": {
"getTeamMembers": {
"agents": [
{
"id": "552c198f-f806-45a0-990f-08586c5a8c95",
"full_name": "Tony Stark",
"first_name": "Tony",
"last_name": "Stark",
"job_title": "CEO",
"signature": null,
"presence": false,
"teamId": "e719b4a1-b109-497e-b79a-fa746cfc37e4",
"email_address": "tony.stark@gmail.com",
"access_level": null,
"access_level_option": "46e49665-a5d9-4cce-8d15-ab7ebd4240bb",
"language": "b3a499cd-818f-4db2-a494-4cfd350d4865",
"language_iso": "en",
"version": null,
"phone": null,
"last_activity": "2022-08-26T06:56:37.310Z",
"timezone": null,
"network_status": true,
"status": null,
"deleted": false,
"blacklisted": true,
"is_visible": true,
"pair_email": []
}
]
}
}
}
]

List App Fields

Get a list of fields from specific entities.

 

GraphQL Parameters

Parameter GraphQL Type Description
!entity String In order to know the entity object name, you can consult the object name in your Apps configuration.

Required

show_hidden Boolean If true, the response will contain deactivated fields (Deleted fields will not be available)

 

Example Request

query getFields($entity:String,$show_hidden:Boolean) {
  getFields(entity:$entity,show_hidden:$show_hidden){
    id
    name
    name_label
    main_type
    is_required
    is_visible
    is_unique
    default_value
    catalog_type_id
    reference_field_id
    reference_fa_entity_id
    reference_fa_entity_name
  }
}

Example Variables

{
  "entity": "contact",
  "show_hidden": false
}

Example Response

{
    "data": {
        "getFields": [
            {
                "id": "74f6a80b-a4cd-47c7-9005-c56a57bcca43",
                "name": "work_email",
                "name_label": "Work Email",
                "main_type": "email",
                "is_required": null,
                "is_visible": true,
                "is_unique": null,
                "default_value": null,
                "catalog_type_id": null,
                "reference_field_id": null,
                "reference_fa_entity_id": null,
                "reference_fa_entity_name": null
            },
            {
                "id": "a4bf7d16-d9bb-44ac-b0cc-00d3735c9117",
                "name": "contact_field68",
                "name_label": "Account Status",
                "main_type": "reference_join",
                "is_required": null,
                "is_visible": true,
                "is_unique": false,
                "default_value": null,
                "catalog_type_id": null,
                "reference_field_id": "0b5e4659-166a-4e46-aae8-fc69e1fba366",
                "reference_fa_entity_id": "d72a990d-7bfa-55e7-9651-0b2b3889c311",
                "reference_fa_entity_name": "logo"
            },
            {
                "id": "ad5fe3ed-5e14-401b-8440-f76e511783fd",
                "name": "seq_id",
                "name_label": "ID",
                "main_type": "ID",
                "is_required": null,
                "is_visible": true,
                "is_unique": null,
                "default_value": null,
                "catalog_type_id": null,
                "reference_field_id": null,
                "reference_fa_entity_id": null,
                "reference_fa_entity_name": null
            },
            {
                "id": "8076169f-a9df-4443-ad12-764067c2f65c",
                "name": "contact_field57",
                "name_label": "Thumbnail",
                "main_type": "thumbnail",
                "is_required": null,
                "is_visible": true,
                "is_unique": null,
                "default_value": null,
                "catalog_type_id": null,
                "reference_field_id": null,
                "reference_fa_entity_id": null,
                "reference_fa_entity_name": null
            },
            {
                "id": "9a4833c0-5e0c-46b6-a875-3f5be942960c",
                "name": "contact_field4",
                "name_label": "Re-Market Reason",
                "main_type": "reference",
                "is_required": null,
                "is_visible": true,
                "is_unique": null,
                "default_value": null,
                "catalog_type_id": "6b772527-1dee-4cdd-8ba7-f48f79199830",
                "reference_field_id": null,
                "reference_fa_entity_id": "6fc34d02-c890-5661-a157-565d99a4fe37",
                "reference_fa_entity_name": "catalog_type"
            },{
                "id": "16279de3-1044-4d27-b916-cea213236856",
                "name": "created_at",
                "name_label": "Created",
                "main_type": "datetimecomplete",
                "is_required": null,
                "is_visible": true,
                "is_unique": null,
                "default_value": null,
                "catalog_type_id": null,
                "reference_field_id": null,
                "reference_fa_entity_id": null,
                "reference_fa_entity_name": null
            }
        ]
    }
}

List Choice List Values

Get a list of your choice list values based on the field id.

GraphQL Parameters

Parameter GraphQL Type Description
id String Id of the field, you can use getFields API to fetch the id of the field.

Required

pattern String Search pattern, you can add any string value to search for any text field in your records.
limit Int Limit the number of results returned by the query.
subtype String Based on the type of choice list, the possible values can be one of the following:
• “catalogs” – for basic choicelist items
• “agents” – for list of Users
• “fa_entities” – for references to Apps e.g Contacts, Accounts etc.

Example Request

query getFieldItems($id: String, $limit: Int, $offset: Int, $no_nulls: Boolean, $withEmpty: Boolean, $withDynamic: Boolean, $subtype: String, $fromForm: Boolean, $fromWidgetForm: Boolean, $fromLineForm: Boolean) {
getFieldItems(fa_field_config_id: $id, limit: $limit, offset: $offset, no_nulls: $no_nulls, withEmpty: $withEmpty, withDynamic: $withDynamic, subtype: $subtype, fromForm: $fromForm, fromWidgetForm: $fromWidgetForm, fromLineForm: $fromLineForm) {
id
name
sub_name
order
metadata
}
}

Example Variables

{
"id": "94537ed4-d773-4103-9317-0ba3f9f5e0b6",
"offset": 0,
"limit": 20,
"subtype": "catalogs"
}

Example Response

{
    "data": {
        "getFieldItems": [
            {
                "__typename": "faFieldReference",
                "id": "f122f1db-f23c-4cf3-bcb5-c42fb4aeef5c",
                "name": "Lead",
                "sub_name": null,
                "order": 1,
                "hide_in_cycle_time": false,
                "metadata": {
                    "custom_fields": null,
                    "user_defined_value": null
                },
                "entity": null,
                "entity_value": null,
                "cache_key": null
            },
            {
                "__typename": "faFieldReference",
                "id": "b24992ad-edf1-4868-b203-4518d6c69524",
                "name": "Customer",
                "sub_name": null,
                "order": 2,
                "hide_in_cycle_time": false,
                "metadata": {
                    "custom_fields": null,
                    "user_defined_value": null
                },
                "entity": null,
                "entity_value": null,
                "cache_key": null
            },
            {
                "__typename": "faFieldReference",
                "id": "e63c5307-1221-43a5-bb18-6e34db469371",
                "name": "Partner",
                "sub_name": null,
                "order": 3,
                "hide_in_cycle_time": false,
                "metadata": {
                    "custom_fields": null,
                    "user_defined_value": null
                },
                "entity": null,
                "entity_value": null,
                "cache_key": null
            },
            {
                "__typename": "faFieldReference",
                "id": "43808a36-e1ee-43fe-a663-07f29f323d90",
                "name": "Other",
                "sub_name": null,
                "order": 4,
                "hide_in_cycle_time": false,
                "metadata": {
                    "custom_fields": null,
                    "user_defined_value": null
                },
                "entity": null,
                "entity_value": null,
                "cache_key": null
            }
        ]
    }
}

Mutations

Mutation queries modify data in your account, mutations can be used to insert, update or delete data.

Automated Import

For integrating 3rd party systems like your organization’s ERP or other enterprise systems. Often it’s used to both ‘create’ new records as well as for ‘updates’ to keep systems in sync.

Example Curl Request

curlhttps://freeagent.network/api/graphql 
  --header "Content-Type: multipart/form-data" 
  --header "Authorization: Bearer XXXXXXXX
-F operations='{ "query": "mutation importEntities($upload: Upload!){ importEntities(entity: "contact", file: "demo", upload: $upload) { importId}}", "variables": {"upload": null} }' 
  -F map='{ "0": ["variables.upload"] }' 
  -F 0=@/Users/ram/Desktop/contact_import_test.csv

 

Create App Record

Create a record for any of your apps without line items.

GraphQL Parameters

Parameter GraphQL Type Description
entity String In order to know the entity object name, you can consult the object name in your Apps configuration.

Required

field_values {field_name : value} The field name must be the system field name. In order to know the system name of the field you want to affect, from FreeAgent CRM as administrator navigate to:

Admin Settings > App Setup > {your_app} > Form Fields.
Example: { "work_email" : "test@test.com", "contact_field1" : "text" }

For references and choice list it’s required to use the ID of the value

Required

Example Request

mutation createEntity($entity: String!, $field_values: JSON!) {
createEntity(entity: $entity, field_values: $field_values) {
entity_value {
id
seq_id
field_values
}
}
}

Example Variables

{
    "entity" : "contact",
    "field_values" : {
        "first_name" : "Test",
        "last_name" : "test",
        "work_email" : "test@test.com"
    }
}

Example Response

{
    "data": {
        "createEntity": {
            "entity_value": {
                "id": "7a16dd45-75a1-4cb5-9aba-b15002364772",
                "seq_id": "CON122389",
                "field_values": {
                    "work_email": {
                        "id": "74f6a80b-a4cd-47c7-9005-c56a57bcca43",
                        "value": "test@test.com",
                        "display_value": "test@test.com",
                        "type": "email",
                        "metadata": null
                    },
                    "seq_id": {
                        "id": "ad5fe3ed-5e14-401b-8440-f76e511783fd",
                        "value": "CON122389",
                        "display_value": "CON122389",
                        "type": "ID",
                        "metadata": null
                    },
                    "full_name": {
                        "id": "cfbae798-bb08-401f-a358-aa86bd3c6bff",
                        "value": "Test test",
                        "display_value": "Test test",
                        "type": "text",
                        "metadata": null
                    },
                    "first_name": {
                        "id": "7e29968c-b6d9-4584-bbc1-3a0b03b6aae1",
                        "value": "Test",
                        "display_value": "Test",
                        "type": "text",
                        "metadata": null
                    },
                    "last_name": {
                        "id": "1ed560e9-0d1a-44b9-b2ec-8e56d1baecc5",
                        "value": "test",
                        "display_value": "test",
                        "type": "text",
                        "metadata": null
                    },
                    ...
                }
            }
        }
    }
}

Update App Record

Update one record for any of your apps.

GraphQL Parameters

Parameter GraphQL Type Description
!entity String In order to know the entity object name, you can consult the object name in your Apps configuration.

Required

!id String The id must be the UUID record id. In order to know the id of a record you can use the endpoint listEntityValues

Required

!field_values {field_name : value} The field name must be the system field name. In order to know the system name of the field you want to affect, from FreeAgent CRM as administrator navigate to:

Admin Settings > App Setup > {your_app} > Form Fields

Example: { "work_email" : "test@test.com", "contact_field1" : "text" }

For references and choice list it’s required to use the ID of the value

Required

Request Example

mutation updateEntity($entity: String!, $id: String!, $field_values: JSON!) {
    updateEntity(entity: $entity, id: $id,field_values: $field_values) {
      entity_value {
        id
        seq_id
        field_values
      }
    }
  }

Example Variables

{
    "entity": "contact",
    "id": "83efbbae-c8eb-47ac-afea-161e951f7564",
    "field_values": {
      "first_name" : "Ivan Andres",
      "lead_owner_id" : "dd3129cf-ff7e-4ef5-8d5b-daf027a913f1"
    }
  }

Example Response

{
    "data": {
        "updateEntity": {
            "entity_value": {
                "id": "83efbbae-c8eb-47ac-afea-161e951f7564",
                "seq_id": "CON122470",
                "field_values": {
                    "seq_id": {
                        "id": "ad5fe3ed-5e14-401b-8440-f76e511783fd",
                        "value": "CON122470",
                        "display_value": "CON122470",
                        "type": "ID",
                        "metadata": null
                    },
                    "work_email": {
                        "id": "74f6a80b-a4cd-47c7-9005-c56a57bcca43",
                        "value": "ivan.carrillo@softwaretp.com",
                        "display_value": "ivan.carrillo@softwaretp.com",
                        "type": "email",
                        "metadata": null
                    },
                    "full_name": {
                        "id": "cfbae798-bb08-401f-a358-aa86bd3c6bff",
                        "value": "Ivan Andres Carrillo Bustos",
                        "display_value": "Ivan Andres Carrillo Bustos",
                        "type": "text",
                        "metadata": null
                    },
                    "last_name": {
                        "id": "1ed560e9-0d1a-44b9-b2ec-8e56d1baecc5",
                        "value": "Carrillo Bustos",
                        "display_value": "Carrillo Bustos",
                        "type": "text",
                        "metadata": null
                    },
                    "logo_id": {
                        "id": "87a33d95-fd4e-4dc2-a7ee-633b7780aae7",
                        "value": "dba4e7f4-8762-4a3e-b279-052dd0774127",
                        "display_value": "Software TP - Test - Ivan",
                        "type": "reference"
                    },
                    "contact_field44": {
                        "id": "bf341295-947d-47f2-a211-297e6bebda93",
                        "value": "dd3129cf-ff7e-4ef5-8d5b-daf027a913f1",
                        "display_value": "Ivan Carrillo",
                        "type": "reference",
                        "metadata": {
                            "full_name": "Ivan Carrillo",
                            "first_name": "Ivan",
                            "last_name": "Carrillo",
                            "portrait_url": "https://freeagent-network-public.s3.us-west-2.amazonaws.com/dd3129cf-ff7e-4ef5-8d5b-daf027a913f1/Screen%20Shot%202020-01-10%20at%204.25.36%20PM_1582359214016.png",
                            "email_address": "ivan.carrillo@freeagentsoftware.com",
                            "extra_info": true,
                            "id": "dd3129cf-ff7e-4ef5-8d5b-daf027a913f1",
                            "display_name": "Ivan Carrillo",
                            "deleted": false
                        }
                    },
                    "lead_owner_id": {
                        "id": "175c7887-1841-4e8a-a784-426c1c6137a6",
                        "value": "dd3129cf-ff7e-4ef5-8d5b-daf027a913f1",
                        "display_value": "Ivan Carrillo",
                        "type": "reference",
                        "metadata": {
                            "full_name": "Ivan Carrillo",
                            "first_name": "Ivan",
                            "last_name": "Carrillo",
                            "portrait_url": "https://freeagent-network-public.s3.us-west-2.amazonaws.com/dd3129cf-ff7e-4ef5-8d5b-daf027a913f1/Screen%20Shot%202020-01-10%20at%204.25.36%20PM_1582359214016.png",
                            "email_address": "ivan.carrillo@freeagentsoftware.com",
                            "extra_info": true,
                            "id": "dd3129cf-ff7e-4ef5-8d5b-daf027a913f1",
                            "display_name": "Ivan Carrillo",
                            "deleted": false
                        }
                    }
                }
            }
        }
    }
}

Bulk Update App Records

Update one or multiple records for any of your apps.

If you update more than 250 records, the process will occur in an async process and can be tracked in the Jobs page. The sent_to_job response value will be “True”

GraphQL Parameters

Parameter GraphQL Type Description
!entity String In order to know the entity object name, you can consult the object name in your Apps configuration.

Required

pattern String Search pattern, you can add any string value to search for any text field in your records.
!ids [String] The array must contain the id of the record/records you want to update. In order to know the id of a record you can use the endpoint listEntityValues

Required

!field_values {field_name : value} The field name must be the system field name. In order to know the system name of the field you want to affect, from FreeAgent CRM as administrator navigate to:

Admin Settings > App Setup > {your_app} > Form Fields

Example: { "work_email" : "test@test.com", "contact_field1" : "text" }

For references and choice list it’s required to use the ID of the value

Required

filters [ { field_name : String, operator : String, values : [String] } ] Filter the list by a set of fields, if multiple fields are specified will be added between the fields.

Example:

[ { "field_name": "seq_id", "operator" : "contains" "values": ["CON106633"] }, { "field_name" : "date_field", "operator" : "between", "values" : [ "2020-10-07T05:00:00.000Z", "2020-10-09T04:59:59.000Z" ] } ]

Available operators

Field Type Operators
Non Date Fields contains does not contains equals not equals starts with
Date Fields after before between

Example Request

mutation bulkUpdateEntities($entity: String!, $ids: [String]!, $field_values: JSON!, $filters: [Filter], $pattern: String) {
    bulkUpdateEntities(entity: $entity, ids: $ids, field_values: $field_values, filters: $filters, pattern: $pattern) {
      sent_to_job
    }
  }

Example Variables

{
    "entity" : "contact",
    "field_values" : {
      "first_name": "Ivan Andres"
    },
    "ids" : ["897cd2cd-1dbb-4f48-a248-5760ccf18bfa"],
    "filters" : [],
    "pattern" : ""
}

Example Response

{
    "data": {
      "bulkUpdateEntities": {
        "sent_to_job": null
      }
    }
}

Delete App Record

Delete one record for any of your apps.

GraphQL Parameters

Parameter GraphQL Type Description
!entity String In order to know the entity object name, you can consult the object name in your Apps configuration.

Required

!id String The id must be the UUID record id. In order to know the id of a record you can use the endpoint listEntityValues

Required

Example Request

mutation deleteEntity($entity: String!, $id: String!) {
    deleteEntity(entity: $entity, id: $id) {
      entity_value {
        id
      }
    }
  }  

Example Variables

{
    "entity": "contact",
    "id": "aa780132-9892-4fb7-9602-b7da1e1ed0cb"
}

Example Response

{
    "data": {
        "deleteEntity": {
            "entity_value": {
                "id": "aa780132-9892-4fb7-9602-b7da1e1ed0cb"
            }
        }
    }
}

🙄

😐

😊

😍

Welcome to servis.ai Free Edition

Link your email to begin

Continue with Google

Continue with Microsoft

By continuing, you agree to servis.ai Terms of Use. Read our Privacy Policy.

Get Started with servis.ai

30-minute demo where you see servis.ai in action.

Unlock the essential servis.ai features at no cost.

How can I be of servis?
How can I be of servis?