Jump to

• Request
• Response

Retrieve a list of subscription

post

/api/rest/2.0/data/sms/subscription

Retrieve consent of a list of phone numbers, a maximum of 10 phone numbers can be passed in a single request.

Request

Supported Media Types

• application/json

Header Parameters

• X-HTTP-Method-Override(required): string(string)
  ISmsSubscriptionService_Parameter_Search_xhttpmethodoverride_Description

  Default Value: SEARCH

Body ()

The request body defines the details of the subscription message to be updated.

Root Schema : PhoneNumberSubscriptionSearch

Type: object

Title: PhoneNumberSubscriptionSearch

Show Source

• depth: string
  Read Only: true

  PhoneNumberSubscriptionSearch_Field_Depth_Description
• phoneNumbers: array phoneNumbers
  PhoneNumberSubscriptionSearch_Field_PhoneNumbers_Description
• type: string
  PhoneNumberSubscriptionSearch_Field_Type_Description

{
    "title":"PhoneNumberSubscriptionSearch",
    "properties":{
        "type":{
            "type":"string",
            "description":"PhoneNumberSubscriptionSearch_Field_Type_Description"
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"PhoneNumberSubscriptionSearch_Field_Depth_Description"
        },
        "phoneNumbers":{
            "type":"array",
            "description":"PhoneNumberSubscriptionSearch_Field_PhoneNumbers_Description",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : phoneNumbers

Type: array

PhoneNumberSubscriptionSearch_Field_PhoneNumbers_Description

Show Source

• Array of: string

{
    "type":"array",
    "description":"PhoneNumberSubscriptionSearch_Field_PhoneNumbers_Description",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : PhoneNumberSubscription

Type: object

Title: PhoneNumberSubscription

Show Source

• history: array history
  PhoneNumberSubscription_Field_History_Description
• normalizedPhoneNumber: string
  PhoneNumberSubscription_Field_NormalizedPhoneNumber_Description
• originalPhoneNumber: string
  PhoneNumberSubscription_Field_OriginalPhoneNumber_Description
• status: string
  PhoneNumberSubscription_Field_Status_Description
• timestamp: string
  PhoneNumberSubscription_Field_Timestamp_Description
• type: string
  PhoneNumberSubscription_Field_Type_Description

{
    "title":"PhoneNumberSubscription",
    "properties":{
        "type":{
            "type":"string",
            "description":"PhoneNumberSubscription_Field_Type_Description"
        },
        "status":{
            "type":"string",
            "description":"PhoneNumberSubscription_Field_Status_Description"
        },
        "timestamp":{
            "type":"string",
            "description":"PhoneNumberSubscription_Field_Timestamp_Description"
        },
        "originalPhoneNumber":{
            "type":"string",
            "description":"PhoneNumberSubscription_Field_OriginalPhoneNumber_Description"
        },
        "normalizedPhoneNumber":{
            "type":"string",
            "description":"PhoneNumberSubscription_Field_NormalizedPhoneNumber_Description"
        },
        "history":{
            "type":"array",
            "description":"PhoneNumberSubscription_Field_History_Description",
            "items":{
                "$ref":"#/definitions/PhoneNumberSubscriptionHistoryRest20"
            }
        }
    }
}

Nested Schema : history

Type: array

PhoneNumberSubscription_Field_History_Description

Show Source

• Array of: object PhoneNumberSubscriptionHistory
  Title: PhoneNumberSubscriptionHistory

{
    "type":"array",
    "description":"PhoneNumberSubscription_Field_History_Description",
    "items":{
        "$ref":"#/definitions/PhoneNumberSubscriptionHistoryRest20"
    }
}

Nested Schema : PhoneNumberSubscriptionHistory

Type: object

Title: PhoneNumberSubscriptionHistory

Show Source

• sourceType: string
  Allowed Values: [ "CreateEntity", "UpdateEntity", "ContactAsynchronousClear", "BulkUpdate", "WorkFlowUpdateRule", "ProgramBuilderUpdateRule", "ProgramBuilderDedupeHandler", "BulkApi", "DataImport", "SharedListRunUpdateRule", "InitialLoad", "SmsSubscriptionRestApi", "SmsSubscriptionBulkApi", "SmsSubscriptionDataImport", "SmsReply", "Visitor" ]
• status: string
• timestamp: string
• type: string
• userId:
  Title: System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

{
    "title":"PhoneNumberSubscriptionHistory",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "timestamp":{
            "type":"string"
        },
        "userId":{
            "$ref":"#/definitions/System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]Rest20"
        },
        "sourceType":{
            "type":"string",
            "enum":[
                "CreateEntity",
                "UpdateEntity",
                "ContactAsynchronousClear",
                "BulkUpdate",
                "WorkFlowUpdateRule",
                "ProgramBuilderUpdateRule",
                "ProgramBuilderDedupeHandler",
                "BulkApi",
                "DataImport",
                "SharedListRunUpdateRule",
                "InitialLoad",
                "SmsSubscriptionRestApi",
                "SmsSubscriptionBulkApi",
                "SmsSubscriptionDataImport",
                "SmsReply",
                "Visitor"
            ]
        }
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.

Back to Top