xodosign API ( 2.0.1 )

Download OpenAPI specification :

BusinessEmail

Retrieves the collection of BusinessEmail resources.

Retrieves the collection of BusinessEmail resources.

Authorizations:
access_key_querybusiness_id_query
query Parameters
page
integer
Default: 1

The collection page number
itemsPerPage
integer >= 0
Default: 30

The number of items per page
emailAddress
string
scope
string
scope[]
Array of strings
status
string
status[]
Array of strings

Responses

Response samples

Content type
{
  • "member": [
    ],
  • "totalItems": 0,
  • "view": {
    },
  • "search": {
    }
}

Creates a BusinessEmail resource.

Creates a BusinessEmail resource.

Authorizations:
access_key_querybusiness_id_query
Request Body schema:
required

The new BusinessEmail resource

emailAddress
required
string < email >
https://schema.org/email
scope
required
string
Value : "custom_requester"

Responses

Request samples

Content type
{
  • "emailAddress": "user@example.com",
  • "scope": "custom_requester"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "hash": "string",
  • "business": "https://example.com/",
  • "emailAddress": "string",
  • "scope": "custom_requester",
  • "status": "unverified",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "https://example.com/"
}

Retrieves a BusinessEmail resource.

Retrieves a BusinessEmail resource.

Authorizations:
access_key_querybusiness_id_query
path Parameters
hash
required
string

BusinessEmail identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "hash": "string",
  • "business": "https://example.com/",
  • "emailAddress": "string",
  • "scope": "custom_requester",
  • "status": "unverified",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "https://example.com/"
}

Removes the BusinessEmail resource.

Removes the BusinessEmail resource.

Authorizations:
access_key_querybusiness_id_query
path Parameters
hash
required
string

BusinessEmail identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "title": "string",
  • "detail": "string",
  • "status": 404,
  • "instance": "string",
  • "description": "string",
  • "errorType": "string"
}

Send a verification email

Sends a verification code to the given email address.

Authorizations:
access_key_querybusiness_id_query
path Parameters
hash
required
string

BusinessEmail identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "hash": "string",
  • "business": "https://example.com/",
  • "emailAddress": "string",
  • "scope": "custom_requester",
  • "status": "unverified",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "https://example.com/"
}

Verify a business email address

Submits the verification code sent to the email address. On success the email status transitions to verified and a 204 is returned. This endpoint gets called automatically when you follow the link in the verification email.

Authorizations:
access_key_querybusiness_id_query
path Parameters
hash
required
string

BusinessEmail identifier
Request Body schema:
required

The new BusinessEmail resource

verificationCode
required
string

Responses

Request samples

Content type
{
  • "verificationCode": "string"
}

Response samples

Content type
null