GET communication_plan/preview

Available from R17.0.0

This method returns the customers that will be communicated through a specific communication plan.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

communication_plan_identifier

(mandatory)

Communication Plan Identifier

The identifier of the communication plan through which the customers returned as a result will be communicated. The allowed communication plan type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the communication plan

name

(semi-optional)

String

The name of the communication plan

alternative_code

(semi-optional)

String

The alternative code of the communication plan

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
contact_information_id	String	The ID of the retrieved contact information
contact_information_name	String	The full name of the retrieved contact information

Examples

Example 1

{
   "data":[
      {
         "contact_information_name":"John F. Doaka 512",
         "contact_information_id":"5667EB1570B842CA87E7FBBE87929083"
      },
      {
         "contact_information_name":"John I. Dovld 552",
         "contact_information_id":"88C06D73ACB94FD1BB2220EBC27AB55F"
      },
      {
         "contact_information_name":"John K. Dohrw 132",
         "contact_information_id":"FA7406D63A8941ED935BA86EC13E75B4"
      },
      {
         "contact_information_name":"John T. Dogty 540",
         "contact_information_id":"08326AADA8074D00BDE9F23A7AA4E625"
      },
      {
         "contact_information_name":"John H. Dovru 678",
         "contact_information_id":"88C5C92343A84071929225554BFCFD1A"
      },
      {
         "contact_information_name":"John A. Dokov 424",
         "contact_information_id":"B6CFCC711A644CDC993A9218103C49FE"
      },
      {
         "contact_information_name":"John E. Dotgv 915",
         "contact_information_id":"40960E62CABA4247BFEFFF2827667F2C"
      },
      {
         "contact_information_name":"John Q. Dovko 411",
         "contact_information_id":"9AEB9D3E40654D4799020ED4D28C20DF"
      },
      {
         "contact_information_name":"John S. Dowgd 537",
         "contact_information_id":"4A5B13D4A8FB41EE80C11F29CD267BE4"
      },
      {
         "contact_information_name":"John X. Docmm 163",
         "contact_information_id":"BCE05CB7752D418DA943362B8FE73ED6"
      },
      {
         "contact_information_name":"John Q. Doapp 924",
         "contact_information_id":"149D335824C7487AA91BC37C673A5A00"
      },
      {
         "contact_information_name":"John X. Dokdc 417",
         "contact_information_id":"B4760E4D96C94EBD987E0EFC959EAA17"
      },
      {
         "contact_information_name":"John F. Doiwk 650",
         "contact_information_id":"02579CB6590E4FDE8DE76F59FACC1BD7"
      },
      {
         "contact_information_name":"John L. Domtk 123",
         "contact_information_id":"1C4964E5B87747C5A0BC600E5B7AEF01"
      },
      {
         "contact_information_name":"John J. Dopsa 483",
         "contact_information_id":"62E376B27E6B49149616028B65DBE118"
      },
      {
         "contact_information_name":"John Y. Dodqy 959",
         "contact_information_id":"810D8AAEA29143ABB6E56F5144C88BB2"
      },
      {
         "contact_information_name":"Marina Anton Test",
         "contact_information_id":"7CBC535804F24588AB804FBE405C271B"
      },
      {
         "contact_information_name":"John Z. Dozev 770",
         "contact_information_id":"688DBA326187493CAB3ECC35FB85FE08"
      },
      {
         "contact_information_name":"John M. Doyey 481",
         "contact_information_id":"0CC6FE14167E4517A4DA58142799B258"
      },
      {
         "contact_information_name":"John Q. Dowbq 496",
         "contact_information_id":"BE10B823572246869F515D37A3BC5F68"
      },
      {
         "contact_information_name":"John R. Dophu 166",
         "contact_information_id":"3ACF9454C6CB43F9BA219462DA3B5B6E"
      },
      {
         "contact_information_name":"John Z. Dodwg 54",
         "contact_information_id":"5F8CEA5BB0BE414880621BF9230CB4BA"
      },
      {
         "contact_information_name":"John P. Dosws 64",
         "contact_information_id":"E9D6376B00254DCB837A38EC2AC267F1"
      },
      {
         "contact_information_name":"John A. Doucj 636",
         "contact_information_id":"7C5EEFC5EED7453B9303704193F55D01"
      },
      {
         "contact_information_name":"John R. Doenv 424",
         "contact_information_id":"3F33DAFFBFA041A287D87B3D7894E18E"
      },
      {
         "contact_information_name":"John Y. Doggc 869",
         "contact_information_id":"59997DCF2D744A5B89127CE565E14697"
      },
      {
         "contact_information_name":"John G. Doxxl 933",
         "contact_information_id":"5834F31E54B147C4BA74B01D47C7F7FE"
      },
      {
         "contact_information_name":"John V. Domgv 944",
         "contact_information_id":"C91AF5D5B85A46AAB26B55F096AD7C16"
      }
   ],
   "status":{
      "code":"OK",
      "description":"",
      "message":""
   }
}