Home / Recipients / mailing

Recipients ‐ mailing


Description:

Get the recipients for a specific mailing except forgotten subscribers.

The following errors can occur:
- Token not present in request.
- Token not in the required format.
- Session does not exist.
- Session has expired.
- The user does not exist.
- No database specified.
- Database parameter not in correct format.
- You are not allowed to access this database.
- The since parameter can not be empty.

Example:

You should call this function as followed:
- rest/v2/recipients/forMailing?token=TOKEN&database=DATABASE_ID&mailing_id=MAILING_ID&offset=INTEGER&records=INTEGER

                require_once 'Rest.php';

                $username = 'my_username';
                $password = 'my_password';
                $database = '999';

                $rest = new Rest($username, $password, $database);
                $result = $rest->call('recipients/mailing', [
                	'mailing_id' => 'MAILING_ID',
'offset' => 'INTEGER',
'records' => 'INTEGER' ], 'GET'); var_dump($result);

Parameters:

The following parameters this method can/should be called with:

key: mailing_id
values: integer, required
what: The ID of the mailing you want to receive the recipients from

key: offset
values: integer, not required
what: pagination, where to start, zero based

key: records
values: integer, not required
what: pagination, amount of records to return, max 5000

See:

The following items:
- user/login For the TOKEN
- user/database For the DATABASE_ID