Update identity
post/v1/senderIdentities/updateUpdates the name of the existing sender identity. Should provide the email address of the sender identity for this.
Code snippet
curl -X 'POST' \ 'https://api.boldsign.com/v1/senderIdentities/update?email=luthercooper%40cubeflakes.com' \ -H 'accept: */*' \ -H 'X-API-KEY: {your API key}' \ -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \ -d '{ "name": "Luther", "redirectUrl": "https://boldsign.com", "notificationSettings": { "viewed": true, "sent": false, "deliveryFailed": true, "declined": true, "revoked": true, "reassigned": true, "completed": true, "signed": true, "expired": true, "authenticationFailed": true, "reminders": true, "attachSignedDocument": false }, "metaData": { "accountPlan": "Paid" } }'
var apiClient = new ApiClient("YOUR_API_KEY"); var senderIdentityClient = new SenderIdentityClient(apiClient); var senderIdentityRequest = new SenderIdentityRequest("Luther", "luthercooper@cubeflakes.com", null); senderIdentityRequest.MetaData = new Dictionary<string, string>() { ["accountPlan"] = "Paid" }; senderIdentityClient.UpdateSenderIdentity(senderIdentityRequest);
import boldsign configuration = boldsign.Configuration(api_key="YOUR_API_KEY") with boldsign.ApiClient(configuration) as api_client: sender_identities_api = boldsign.SenderIdentitiesApi(api_client) sender_identity_request = boldsign.EditSenderIdentityRequest(name="Luther") sender_identities_api.update_sender_identities(email="luthercooper@cubeflakes.com", edit_sender_identity_request=sender_identity_request)
<?php require_once "vendor/autoload.php"; use BoldSign\Configuration; use BoldSign\Api\SenderIdentitiesApi; use BoldSign\Model\EditSenderIdentityRequest; $config = new Configuration(); $config->setApiKey('YOUR_API_KEY'); $sender_identities_api = new SenderIdentitiesApi($config); $sender_identity_request = new EditSenderIdentityRequest(); $sender_identity_request->setName('Luther'); $sender_identities_api->updateSenderIdentities($email = 'luthercooper@cubeflakes.com', $sender_identity_request);
ApiClient client = Configuration.getDefaultApiClient(); client.setApiKey("YOUR_API_KEY"); SenderIdentitiesApi senderIdentitiesApi = new SenderIdentitiesApi(client); EditSenderIdentityRequest senderIdentityRequest = new EditSenderIdentityRequest(); senderIdentityRequest.setName("Luther"); senderIdentitiesApi.updateSenderIdentities("luthercooper@cubeflakes.com", senderIdentityRequest);
import { SenderIdentitiesApi, EditSenderIdentityRequest } from "boldsign"; const senderIdentitiesApi = new SenderIdentitiesApi(); senderIdentitiesApi.setApiKey("YOUR_API_KEY"); const senderIdentityRequest = new EditSenderIdentityRequest(); senderIdentityRequest.name = "Luther"; senderIdentitiesApi.updateSenderIdentities("luthercooper@cubeflakes.com", senderIdentityRequest);
Query parameters
emailStringRequired | Email address of the sender identity. |
Request body
nameString | Name of the sender identity. Either name or redirectUrl or metaData is required to update. | ||||||||||||||||||||||||
redirectUrlstring | You can set this property to redirect to a specific URL once the user has either approved or rejected. Either name or redirectUrl or metaData is required to update. | ||||||||||||||||||||||||
notificationSettingsobject | Notification Settings of the sender identity.
| ||||||||||||||||||||||||
metaDatadictionary | The metadata update operation performs a partial update for the sender identity metadata. If the metadata key is already present, it will be updated with the new value. If the metadata key is absent, it will be added to the sender identity. If the metadata value is empty for a key, it will be removed from the sender identity. Any existing metadata that is not included in the request will remain unchanged. |
Partial update
The metadata update always performs a partial update. If the metadata already exists, it will be updated with the new value. If the metadata does not exist, it will be added to the sender identity. If any of the existing metadata is not passed in the request, the existing key-value pairs will not be affected.
Deleting metadata
The metadata can be removed by providing an empty string as the value for the key. This will eliminate the key-value pair from the sender identity metadata.
Example response
204 No content