Customer

The person who will be receiving the signing action.

PreviousBundle NextDocument

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
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
Authorization: Bearer YOUR_OAUTH2_TOKEN
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
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "text"
]

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "Example 1": {
    "CustomerId": "140516ff-772f-4843-b1ad-8c7697aaf36e",
    "TenantId": "ca19865d-216b-4e90-b6e1-c399bb520367",
    "Name": "Customer Lastname",
    "Email": "recipient.email@provider.com",
    "PhoneNumber": "+611111111",
    "NoMobile": false,
    "Meta": "b340a02e-8557-4460-b251-064faa46e965",
    "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
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "CustomerId": null,
  "Name": "Customer Lastname",
  "Email": "recipient.email@provider.com",
  "PhoneNumber": "+611111111",
  "NoMobile": false,
  "Meta": "560aeece-7a40-435a-8377-715553131d6f",
  "CannotModify": false,
  "Options": {
    "IgnorePhoneNumberIfInvalid": false,
    "UpdateExistingCustomersByMetaMatch": false
  }
}

{
  "Example 1": {
    "CustomerId": "7927f713-deba-4c95-b009-aa7341d3e216",
    "TenantId": "4301ae4e-fd2b-44f6-b2bd-a2fd610c8493",
    "Name": "Customer Lastname",
    "Email": "recipient.email@provider.com",
    "PhoneNumber": "+611111111",
    "NoMobile": false,
    "Meta": "18452bff-11ba-4854-a709-82b7bc187efc",
    "CannotModify": false,
    "Source": "Manual",
    "CustomerEditLink": null,
    "TotalLiveBundlesForCustomer": null,
    "TotalBundlesForCustomer": null
  }
}