---
title: "Modifying Entities via the API"
slug: "modifying-entities-via-the-api"
updated: 2025-07-03T20:35:15Z
published: 2025-07-03T20:35:15Z
canonical: "docs.onespan.com/modifying-entities-via-the-api"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onespan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Modifying Entities via the API

All entities can be modified using the OneSpan Sign Embedded Integration for CRM API. The API in OneSpan Sign Embedded Integration for CRM can be accessed through the organization service called `organization.svc`.

By navigating to Settings > Customizations > Developer Resources, integrators can use the API to perform the following operations:

- Create, update, and delete Convention records
- Create, update, and delete new Signer Label records
- Create, update, and delete new Text Tag records
- Associate Conventions to Templates
- Associate Conventions to Transactions
- Associate Signer Labels to Signers within a Transaction or Template
- Create, update, and delete Field Mapping records
- Enable or disable auto-prepare settings for a Transaction or a Template
- Enable or disable insert settings for a Transaction or a Template
- Activate or deactivate Conventions

For more information, consult this [API website](https://msdn.microsoft.com/en-ca/library/mt593051.aspx).

This section describes the following:

- [Connecting to an Organization](/v1/docs/modifying-entities-via-the-api#connecting-to-an-organization)
- [Creating a Record](/v1/docs/modifying-entities-via-the-api#creating-a-record)
- [Updating a Record](/v1/docs/modifying-entities-via-the-api#updating-a-record)
- [Deleting a Record](/v1/docs/modifying-entities-via-the-api#deleting-a-record)
- [Associating an Entity Record to Another](/v1/docs/modifying-entities-via-the-api#associating-an-entity-record-to-another)

## Connecting to an Organization

| Description/Purpose | **ServiceProxy**: Provides an authenticated WCF channel to the organization service |
| --- | --- |
| Parameters | - Uri: The URI of the organization service - HomeRealmUri: This parameter is set to a non-null value when a second ADFS instance is configured as an Identity Provider to the ADFS instance to which OneSpan Sign Embedded Integration for CRM has been configured for claims authentication. The parameter value is the URI of the WS-Trust metadata endpoint of the second ADFS instance. - ClientCredentials: The logon credentials of the client - DeviceCredentials: The Windows Live ID device credentials. |
| Returned values | URI of the organization service |

Refer to the following code snippet for the connection setup. This connects to a specific organization in OneSpan Sign Embedded Integration for CRM.

![](https://cdn.document360.io/038f59a7-abd0-4c14-9de7-3434d28b49fd/Images/Documentation/code_snippet1.png)

## Creating a Record

| Description/Purpose | **ServiceProxy**.Create: Creates a new record |
| --- | --- |
| Parameters | Entity: An entity instance that contains the properties to set in the newly created record. E.g. Account, Lead, etc. |
| Returned values | GUID of the newly created record |

To create a new entity record, refer to the following code snippet. Records can be created into any of the entities in OneSpan Sign Embedded Integration for CRM.

![](https://cdn.document360.io/038f59a7-abd0-4c14-9de7-3434d28b49fd/Images/Documentation/code_snippet2.png)

## Updating a Record

| Description/Purpose | **ServiceProxy**.Update: Updates an existing entity |
| --- | --- |
| Parameters | Entity: An entity instance that contains the properties to set in the newly created record. E.g. Account, Lead, etc. |
| Returned values |  |

To update a field value, refer to the following code snippet:

![](https://cdn.document360.io/038f59a7-abd0-4c14-9de7-3434d28b49fd/Images/Documentation/code_snippet_update_record.png)

## Deleting a Record

| Description/Purpose | **ServiceProxy**.Delete: Deletes an existing entity |
| --- | --- |
| Parameters | Entity: An entity instance that contains the properties to set in the newly created record. E.g. Account, Lead, etc. GUID: The GUID of the record to delete. |
| Returned values |  |

To delete a record in an entity, refer to the following code snippet:

![](https://cdn.document360.io/038f59a7-abd0-4c14-9de7-3434d28b49fd/Images/Documentation/code_snippet_delete_record.png)

## Associating an Entity Record to Another

| Description/Purpose | **ServiceProxy**.Associate: Associates an existing entity to another |
| --- | --- |
| Parameters | Entity: An entity instance that contains the properties to set in the newly created record. E.g. Account, Lead, etc. GUID: The GUID of the record to delete. Relationship: The name of the relationship to be used to create the link. EntityReferenceCollection: A collection of entity references (to records) to be associated. |
| Returned values |  |

To associate one entity record to another, refer to the following code snippet:

![](https://cdn.document360.io/038f59a7-abd0-4c14-9de7-3434d28b49fd/Images/Documentation/code_snippet_associate_record.png)