POST {ClientId}/AddNumberAuth/{PhoneNumber}
Adds a number to a filter. Authorization header is required.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ClientId |
PossibleNow ClientId |
string |
Required |
PhoneNumber |
PhoneNumber to add. Can't start with 0 or 1, but may contain dashes. Must contain 10 digits |
string |
Required |
Body Parameters
PhoneNumber info record
AddNumberInfoName | Description | Type | Additional information |
---|---|---|---|
FilterName |
PossibleNow FilterName |
string |
Required Min length: 1 |
UserId |
PossibleNow UserId |
string |
Required Min length: 1 |
CustomerDate |
CustomerDate. If left blank, current date is used |
string |
None. |
ConsumerName |
Optional name of the consumer |
string |
Max length: 256 |
OptStatus |
OptStatus is an optional field with possible values of 1 (Express Consent) or 2 (Do Not Contact). If omitted, it will be treated as a Do Not Contact. Any value other than 1 or 2, will result in an error. |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "FilterName": "sample string 1", "UserId": "sample string 2", "CustomerDate": "sample string 3", "ConsumerName": "sample string 4", "OptStatus": 5 }
application/xml, text/xml
Sample:
<AddNumberInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DNC.Rest.Models"> <ConsumerName>sample string 4</ConsumerName> <CustomerDate>sample string 3</CustomerDate> <FilterName>sample string 1</FilterName> <OptStatus>5</OptStatus> <UserId>sample string 2</UserId> </AddNumberInfo>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.
Response Codes
- InternalServerError (500)
- NotFound (404)
- BadRequest (400)
- NoContent (204)