Back to API references

SOAP API method Collection_intentions

Description

The intentions' goal is to send mailings to the collection. If there is not the intention 'email', the user cannot send an emailingdocument to the collection. The possible values to get the intentions are 'email', 'sms', 'fax' and 'pdf' You can also add the view to get the intentions for sending mailings to a combination of a view and this collection.

Parameters

Name Type Description
id * int Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
view Structure of type 'view'
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
array array

Structure 'view'

Name Type Description
id int The ID of the view.
name string The name of the view.
description string The description of the view.
archived boolean The view is archived.
buildstatus string The status of the rebuild
countprofiles int The number of profiles.
lastbuilt timestamp When was the profile rebuilt for the last time?

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt