FuseWorks
  • GETTING STARTED
    • An Overview
    • QuickStart Guide
  • Deep Dives
    • Scopes
    • Webhooks
    • Bundle Create
  • API References
    • Session
    • Bundle
    • Customer
    • Document
    • Tenant
  • Resources
    • OpenApi Spec
  • Swagger
  • Integrate With Us
  • Meet 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 1 month 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
includeLiveBundleCountboolean | nullableOptional

Include live bundle count

includeBundleCountsboolean | nullableOptional

Include bundle count

Responses
200Success
application/json
400
Error message
application/json
get
GET /api/Customer/Search HTTP/1.1
Host: api.fuse.work
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
200Success
application/json
400
Error message
application/json
get
GET /api/Customer/SearchByMetaData HTTP/1.1
Host: api.fuse.work
Accept: */*

{
  "Example 1": null
}

Get Country Codes

get

Get the list of allowed country codes for mobile numbers

Authorizations
Responses
200Success
application/json
Responsestring[]
400
Error message
application/json
get
GET /api/Customer/GetCountryCodes HTTP/1.1
Host: api.fuse.work
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
200Success
application/json
400
Error message
application/json
get
GET /api/Customer/Get HTTP/1.1
Host: api.fuse.work
Accept: */*

{
  "Example 1": {
    "CustomerId": "318fb60c-2fa9-4190-a40f-b8d2b48725e1",
    "TenantId": "a8fd4f3a-123f-49c9-a182-e127a56f5936",
    "Name": "Customer Lastname",
    "Email": "recipient.email@provider.com",
    "PhoneNumber": "+611111111",
    "NoMobile": false,
    "Meta": "d390682b-fa2d-42f7-b2c2-66dc2230132d",
    "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
200Success
application/json
400
Error message
application/json
post
POST /api/Customer/Create HTTP/1.1
Host: api.fuse.work
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "CustomerId": null,
  "Name": "Customer Lastname",
  "Email": "recipient.email@provider.com",
  "PhoneNumber": "+611111111",
  "NoMobile": false,
  "Meta": "73c9d949-dca7-4ea7-b123-13bb17ea38fe",
  "CannotModify": false,
  "Options": {
    "IgnorePhoneNumberIfInvalid": false,
    "UpdateExistingCustomersByMetaMatch": false
  }
}
{
  "Example 1": {
    "CustomerId": "4f057a0d-99c6-424a-a999-33cb7ec41168",
    "TenantId": "e9c85453-c596-4dc5-a257-841dd40c568b",
    "Name": "Customer Lastname",
    "Email": "recipient.email@provider.com",
    "PhoneNumber": "+611111111",
    "NoMobile": false,
    "Meta": "c3f419de-6085-4a94-973c-b33af49d2414",
    "CannotModify": false,
    "Source": "Manual",
    "CustomerEditLink": null,
    "TotalLiveBundlesForCustomer": null,
    "TotalBundlesForCustomer": null
  }
}