This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Update contact

PUT

https://api.signater.com/v1/ecm/contacts/{contactId}

Contact

Last modified:2025-03-29 12:47:42

Updates the details of an existing contact in the system using its unique identifier. This endpoint allows modifications to fields such as name, email, or other associated metadata. Ensure the contact ID provided exists and that the payload contains the updated information.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

contactId

string <uuid>

required

Contact ID

Body Params application/json

name

string

required

Name of the contact

>= 2 characters<= 200 characters

role

enum<string> | enum<null>

optional

Role of the contact

Allowed values:

SignApproveRecognizeTestifyConfirmReceivingEndorseInBlackEndorseInWhiteConfirm

title

string | null

optional

Title of the contact

<= 200 characters

string | null

optional

Email address of the contact

Match pattern:

^([\w\.\-]+)@([\w\-]+)((\.(\w){2,3})+)$

phoneIdd

integer <int32> | null

optional

Phone IDD of the contact, e.g. '1' for the United States or '55' for Brazil

phoneNumber

string | null

optional

Phone number of the contact excluding the IDD

documentType

enum<string> | enum<null>

optional

Document type of the contact

Allowed values:

GenericIdentificationBrazilianCpf

documentValue

string | null

optional

Document value of the contact

description

string | null

optional

Description of the contact

<= 2000 characters

Example

{
  "name": "John Doe",
  "role": "Approve",
  "title": "Project Manager",
  "email": "john.doe@example.com",
  "phoneIdd": 1,
  "phoneNumber": "1234567890",
  "documentType": "GenericIdentification",
  "documentValue": "A1234567",
  "description": "A contact person for project management."
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.signater.com/v1/ecm/contacts/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "John Doe",
    "role": "Approve",
    "title": "Project Manager",
    "email": "john.doe@example.com",
    "phoneIdd": 1,
    "phoneNumber": "1234567890",
    "documentType": "GenericIdentification",
    "documentValue": "A1234567",
    "description": "A contact person for project management."
}'

Responses

🟢204No Content

Contact updated successfully

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-03-29 12:47:42

Get contact

Remove contact