Conversation Fetch

Fetch All Conversations

Usage: GET /data/conversation

Returns the name and ID of all Conversation objects accessible by the current user. The full Conversation object may subsequently be fetched by ID.

Example JSON Response Data

[
{"id":721,"name":"Test"},
{"id":940,"name":"Store 01"},
{"id":941,"name":"Test Store 01"},
{"id":1000,"name":"Interest List"},
]

Fetch Conversation By ID

Usage: GET /data/conversation/id/{conversation id}

Example: GET /data/conversation/id/940

Returns the Conversation object identified by the database primary key.

Example JSON Response Data

{"id":940,
"name":"Store 01",
"customerCount":"Uncalculated",
"departmentID":212,
"senderID":0,
"signingEnabled":false,
"mailFarmID":1,
"receiverDomain":1,
"referFriendDefaultText":"",
"unsubscribeDefaultText":""
}

Fetch Conversation By Name

Usage: GET /data/conversation/name/{conversation name}

Example: GET /data/conversation/name/Store 01
Note: Names with spaces may need to be URL Encoded, e.g. GET /data/conversation/name/Store%2001.

Returns the Conversation object identified by name.

Example JSON Response Data

{"id":940,
"name":"Store 01",
"customerCount":"Uncalculated",
"departmentID":212,
"senderID":0,
"signingEnabled":false,
"mailFarmID":1,
"receiverDomain":1,
"referFriendDefaultText":"",
"unsubscribeDefaultText":""
}