Jump to

• Request
• Response

Get an email verification

get

/crmRestApi/resources/11.13.18.05/emailVerification/{Id}

Request

Path Parameters

• Id(required): integer
  The unique identifier of the verified data.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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