Update a phone verification
patch
/crmRestApi/resources/11.13.18.05/phoneVerification/{Id}
Request
Path Parameters
-
Id(required): integer
The unique identifier for the verification API.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CountryPrefix: string
The country prefix that must be prepended to the number when dialing internationally.
-
Id: integer
The unique identifier for the verification API.
-
IsValid: string
Indicates whether the number is valid or not. This returns Unknown if validation was not possible.
-
NationalFormat: string
The domestic network format which is useful for dialing from within the same country.
-
NetworkCode: string
The current operator serving the supplied number.
-
NetworkCountry: string
The country code of the operator.
-
NetworkName: string
The name of the current operator serving the supplied number.
-
NumberType: string
The type of number that was detected in the request such as MOBILE, LANDLINE, or VOIP.
-
PhoneNumber: string
The recipient phone number in international format.
-
PhoneVerificationEnabled: string
Indicates whether the verification service is enabled.
-
RequestProcessed: string
The request process. This returns true if the request on the network is processed or false if the validation was unsuccessful.
-
VerificationCode: string
The verification code of the phone number provided.
-
VerificationHelpText: string
A textual help description of the verification status returned.
-
VerificationStatus: string
The verification status of the phone number provided.
-
VerificationText: string
A description of the verification code returned.
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.
Root Schema : phoneVerification-item-response
Type:
Show Source
object
-
CountryPrefix: string
The country prefix that must be prepended to the number when dialing internationally.
-
Id: integer
The unique identifier for the verification API.
-
IsValid: string
Indicates whether the number is valid or not. This returns Unknown if validation was not possible.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NationalFormat: string
The domestic network format which is useful for dialing from within the same country.
-
NetworkCode: string
The current operator serving the supplied number.
-
NetworkCountry: string
The country code of the operator.
-
NetworkName: string
The name of the current operator serving the supplied number.
-
NumberType: string
The type of number that was detected in the request such as MOBILE, LANDLINE, or VOIP.
-
PhoneNumber: string
The recipient phone number in international format.
-
PhoneVerificationEnabled: string
Indicates whether the verification service is enabled.
-
RequestProcessed: string
The request process. This returns true if the request on the network is processed or false if the validation was unsuccessful.
-
VerificationCode: string
The verification code of the phone number provided.
-
VerificationHelpText: string
A textual help description of the verification status returned.
-
VerificationStatus: string
The verification status of the phone number provided.
-
VerificationText: string
A description of the verification code returned.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.