Jump to

• Request
• Response

Create an email verification

post

/crmRestApi/resources/11.13.18.05/emailVerification

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Domain: string
  The domain portion of the email address provided.
• Duration: string
  The time taken to validate the email, in seconds. The maximum timeout is enforced at 15 seconds. A high timeout value of at least 15 seconds is recommended as it will minimize the number of Timeout responses returned.
• EmailAddress: string
  The email address that was verified.
• EmailVerificationEnabled: string
  Indicates whether the verification service is enabled.
• Id: integer
  The unique identifier of the verified data.
• IsComplainerOrFraudRisk: string
  Indicates whether the email address is recognized against known lists of complainers or if it has been used to defraud.
• IsDisposableOrTemporary: string
  Indicates whether the email address provided is a temporary mailbox. Some organizations create temporary mailboxes which shouldn't be used for marketing communications.
• ResponseCode: string
  The response code such as Valid, Valid_CatchAll, Invalid, and Timeout.
• ResponseMessage: string
  A textual description of the response code returned. For example, Valid means that the email address has been fully validated including the account portion, Valid_CatchAll means that the domain has been validated but the account could not be validated, Invalid means that the email address is invalid and shouldn't be accepted, and Timeout means that the validation could not be completed within the timeout specified. If you receive Timeout as the response code, then increase the timeout value.
• UserAccount: string
  The account portion of the email address provided.
• VerificationCode: string
  The verification code of the email address provided.
• VerificationHelpText: string
  A textual help description of the verification status returned.
• VerificationStatus: string
  The verification status of the email address provided.
• VerificationText: string
  A textual description of the verification code returned.

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "type":"string",
            "description":"The verification status of the email address provided.",
            "nullable":true
        },
        "ResponseCode":{
            "type":"string",
            "description":"The response code such as Valid, Valid_CatchAll, Invalid, and Timeout.",
            "nullable":true
        },
        "VerificationCode":{
            "type":"string",
            "description":"The verification code of the email address provided.",
            "nullable":true
        },
        "Duration":{
            "type":"string",
            "description":"The time taken to validate the email, in seconds. The maximum timeout is enforced at 15 seconds. A high timeout value of at least 15 seconds is recommended as it will minimize the number of Timeout responses returned.",
            "nullable":true
        },
        "ResponseMessage":{
            "type":"string",
            "description":"A textual description of the response code returned. For example, Valid means that the email address has been fully validated including the account portion, Valid_CatchAll means that the domain has been validated but the account could not be validated, Invalid means that the email address is invalid and shouldn't be accepted, and Timeout means that the validation could not be completed within the timeout specified. If you receive Timeout as the response code, then increase the timeout value.",
            "nullable":true
        },
        "EmailAddress":{
            "type":"string",
            "description":"The email address that was verified.",
            "nullable":true
        },
        "IsComplainerOrFraudRisk":{
            "type":"string",
            "description":"Indicates whether the email address is recognized against known lists of complainers or if it has been used to defraud.",
            "nullable":true
        },
        "IsDisposableOrTemporary":{
            "type":"string",
            "description":"Indicates whether the email address provided is a temporary mailbox. Some organizations create temporary mailboxes which shouldn't be used for marketing communications.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the verified data.",
            "nullable":true
        },
        "EmailVerificationEnabled":{
            "type":"string",
            "description":"Indicates whether the verification service is enabled.",
            "nullable":true
        },
        "VerificationText":{
            "type":"string",
            "description":"A textual description of the verification code returned.",
            "nullable":true
        },
        "Domain":{
            "type":"string",
            "description":"The domain portion of the email address provided.",
            "nullable":true
        },
        "UserAccount":{
            "type":"string",
            "description":"The account portion of the email address provided.",
            "nullable":true
        },
        "VerificationHelpText":{
            "type":"string",
            "description":"A textual help description of the verification status returned.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : emailVerification-item-response

Type: object

Show Source

• Domain: string
  The domain portion of the email address provided.
• Duration: string
  The time taken to validate the email, in seconds. The maximum timeout is enforced at 15 seconds. A high timeout value of at least 15 seconds is recommended as it will minimize the number of Timeout responses returned.
• EmailAddress: string
  The email address that was verified.
• EmailVerificationEnabled: string
  Indicates whether the verification service is enabled.
• Id: integer
  The unique identifier of the verified data.
• IsComplainerOrFraudRisk: string
  Indicates whether the email address is recognized against known lists of complainers or if it has been used to defraud.
• IsDisposableOrTemporary: string
  Indicates whether the email address provided is a temporary mailbox. Some organizations create temporary mailboxes which shouldn't be used for marketing communications.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResponseCode: string
  The response code such as Valid, Valid_CatchAll, Invalid, and Timeout.
• ResponseMessage: string
  A textual description of the response code returned. For example, Valid means that the email address has been fully validated including the account portion, Valid_CatchAll means that the domain has been validated but the account could not be validated, Invalid means that the email address is invalid and shouldn't be accepted, and Timeout means that the validation could not be completed within the timeout specified. If you receive Timeout as the response code, then increase the timeout value.
• UserAccount: string
  The account portion of the email address provided.
• VerificationCode: string
  The verification code of the email address provided.
• VerificationHelpText: string
  A textual help description of the verification status returned.
• VerificationStatus: string
  The verification status of the email address provided.
• VerificationText: string
  A textual description of the verification code returned.

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "type":"string",
            "description":"The verification status of the email address provided.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseCode":{
            "type":"string",
            "description":"The response code such as Valid, Valid_CatchAll, Invalid, and Timeout.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationCode":{
            "type":"string",
            "description":"The verification code of the email address provided.",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "type":"string",
            "description":"The time taken to validate the email, in seconds. The maximum timeout is enforced at 15 seconds. A high timeout value of at least 15 seconds is recommended as it will minimize the number of Timeout responses returned.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseMessage":{
            "type":"string",
            "description":"A textual description of the response code returned. For example, Valid means that the email address has been fully validated including the account portion, Valid_CatchAll means that the domain has been validated but the account could not be validated, Invalid means that the email address is invalid and shouldn't be accepted, and Timeout means that the validation could not be completed within the timeout specified. If you receive Timeout as the response code, then increase the timeout value.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "type":"string",
            "description":"The email address that was verified.",
            "nullable":true,
            "x-queryable":true
        },
        "IsComplainerOrFraudRisk":{
            "type":"string",
            "description":"Indicates whether the email address is recognized against known lists of complainers or if it has been used to defraud.",
            "nullable":true,
            "x-queryable":true
        },
        "IsDisposableOrTemporary":{
            "type":"string",
            "description":"Indicates whether the email address provided is a temporary mailbox. Some organizations create temporary mailboxes which shouldn't be used for marketing communications.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the verified data.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailVerificationEnabled":{
            "type":"string",
            "description":"Indicates whether the verification service is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationText":{
            "type":"string",
            "description":"A textual description of the verification code returned.",
            "nullable":true,
            "x-queryable":true
        },
        "Domain":{
            "type":"string",
            "description":"The domain portion of the email address provided.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAccount":{
            "type":"string",
            "description":"The account portion of the email address provided.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationHelpText":{
            "type":"string",
            "description":"A textual help description of the verification status returned.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top