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

Create contact

POST

https://api.signater.com/v1/ecm/contacts

Contact

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

Creates a new contact in the system by accepting essential details such as name, email, and other optional metadata. This endpoint is designed to store reusable information that can streamline the process of assigning contacts as signers. Ensure all required fields are provided in the request payload.

Request

Authorization

Add parameter in header

x-api-token

Example:

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

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 POST 'https://api.signater.com/v1/ecm/contacts' \
--header 'Content-Type: application/json' \
--header 'x-api-token;' \
--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

🟢201Created

application/json

Contact created successfully

Body

string <uuid>

optional

Id of the created contact

Example

{
  "id": "0cb502bc-ed21-4f83-9a70-7848d86b40a5"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

List contacts

Get contact