FuseWorks
  • GETTING STARTED
    • An Overview
    • QuickStart Guide
  • Deep Dives
    • Webhooks
    • Scopes
    • Bundle Create
  • API References
    • Session
    • Bundle
    • Customer
    • Document
    • Tenant
  • Resources
    • OpenApi Spec
  • Swagger
  • Integrate with Us
Powered by GitBook
On this page
Export as PDF
  1. API References

Customer

The person who will be receiving the signing action.

PreviousBundleNextDocument

Last updated 29 days ago

Search customer

get

Search for customer based on Name/Email/Phone details

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant

searchStringstring | nullableRequired

Wildcard search text

collapseDuplicatesbooleanOptional

Collapse any duplicate records

Default: false
excludeArchivedbooleanOptional

Exclude archived contacts

Default: false
includeLiveBundleCountbooleanOptional

Include live bundle count

Default: false
includeBundleCountsbooleanOptional

Include bundle count

Default: false
Responses
application/json
object[]OptionalExample: {"CustomerId":"a7390e6f-d7c9-444a-81d1-7220a66869a2","TenantId":"931f8fb1-16ea-4222-b6bd-259e40919bc1","Name":"Customer Lastname","Email":"recipient.email@provider.com","PhoneNumber":"+611111111","NoMobile":false,"Meta":"46dc45ad-ae20-44cb-9d87-35b8cca70746","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null}
application/json
get
GET /api/Customer/Search HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Example 1": null
}

Search customer by metadata

get

Search for customers based on the external Customer Meta field

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant

metaDataSearchstring | nullableRequired

Wilcard metadata search string

Responses
application/json
object[]OptionalExample: {"CustomerId":"a7390e6f-d7c9-444a-81d1-7220a66869a2","TenantId":"931f8fb1-16ea-4222-b6bd-259e40919bc1","Name":"Customer Lastname","Email":"recipient.email@provider.com","PhoneNumber":"+611111111","NoMobile":false,"Meta":"46dc45ad-ae20-44cb-9d87-35b8cca70746","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null}
application/json
get
GET /api/Customer/SearchByMetaData HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Example 1": null
}

Get Country Codes

get

Get the list of allowed country codes for mobile numbers

Authorizations
Responses
application/json
string[]Optional
application/json
get
GET /api/Customer/GetCountryCodes HTTP/1.1
Host: localhost:3003
Accept: */*

[
  "text"
]
  • GETGet customer
  • POSTCreate a new Customer
  • GETSearch customer
  • GETSearch customer by metadata
  • GETGet Country Codes

Get customer

get

Get customer details from its ID.

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant ID

customerIdstring · guidRequired

FuseSign Customer ID

Responses
application/json
objectOptionalExample: {"CustomerId":"a7390e6f-d7c9-444a-81d1-7220a66869a2","TenantId":"931f8fb1-16ea-4222-b6bd-259e40919bc1","Name":"Customer Lastname","Email":"recipient.email@provider.com","PhoneNumber":"+611111111","NoMobile":false,"Meta":"46dc45ad-ae20-44cb-9d87-35b8cca70746","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null}
application/json
get
GET /api/Customer/Get HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Example 1": {
    "CustomerId": "979f7276-c180-4c13-a5d7-4ae2a45b0052",
    "TenantId": "fa27f655-c305-426b-8b69-6e9e5f822c8d",
    "Name": "Customer Lastname",
    "Email": "recipient.email@provider.com",
    "PhoneNumber": "+611111111",
    "NoMobile": false,
    "Meta": "6f84a167-299e-4c71-8716-64ba3d21bf25",
    "CannotModify": false,
    "Source": "Manual",
    "CustomerEditLink": null,
    "TotalLiveBundlesForCustomer": null,
    "TotalBundlesForCustomer": null
  }
}

Create a new Customer

post

Create a new Customer

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant

Body
one of | nullableOptional
Responses
application/json
objectOptionalExample: {"CustomerId":"a7390e6f-d7c9-444a-81d1-7220a66869a2","TenantId":"931f8fb1-16ea-4222-b6bd-259e40919bc1","Name":"Customer Lastname","Email":"recipient.email@provider.com","PhoneNumber":"+611111111","NoMobile":false,"Meta":"46dc45ad-ae20-44cb-9d87-35b8cca70746","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null}
application/json
post
POST /api/Customer/Create HTTP/1.1
Host: localhost:3003
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "CustomerId": null,
  "Name": "Customer Lastname",
  "Email": "recipient.email@provider.com",
  "PhoneNumber": "+611111111",
  "NoMobile": false,
  "Meta": "f9f2ffc6-d0e7-4996-a333-4a38247affe1",
  "CannotModify": false,
  "Options": {
    "IgnorePhoneNumberIfInvalid": false,
    "UpdateExistingCustomersByMetaMatch": false
  }
}
{
  "Example 1": {
    "CustomerId": "a7390e6f-d7c9-444a-81d1-7220a66869a2",
    "TenantId": "931f8fb1-16ea-4222-b6bd-259e40919bc1",
    "Name": "Customer Lastname",
    "Email": "recipient.email@provider.com",
    "PhoneNumber": "+611111111",
    "NoMobile": false,
    "Meta": "46dc45ad-ae20-44cb-9d87-35b8cca70746",
    "CannotModify": false,
    "Source": "Manual",
    "CustomerEditLink": null,
    "TotalLiveBundlesForCustomer": null,
    "TotalBundlesForCustomer": null
  }
}