{ "opencollection": "1.0.0", "info": { "name": "Listrak Cross Channel REST app-push-mobile-client-device Contact API", "version": "v1" }, "items": [ { "info": { "name": "Contact", "type": "folder" }, "items": [ { "info": { "name": "Get all Contacts", "type": "http" }, "http": { "method": "GET", "url": "https://api.listrak.com/crosschannel/v1/v1/List/:listId/Contact", "params": [ { "name": "listId", "value": "", "type": "path", "description": "Identifier used to locate the list." }, { "name": "subscriptionState", "value": "", "type": "query", "description": "Identifier used to specify subscription state of the contacts to retrieve. Allowed values are `Subscribed` and `Unsubscribed`. The default value is `Subscribed`." }, { "name": "externalContactId", "value": "", "type": "query", "description": "External contact ID provided by the client. If provided, only returns contacts with a matching external contact ID." }, { "name": "segmentationFieldIds", "value": "", "type": "query", "description": "Comma-separated list of profile field IDs to retrieve. Up to 30 fields may be included." }, { "name": "cursor", "value": "", "type": "query", "description": "Value indicating the page of data that's being retrieved. The default value is `Start`." }, { "name": "count", "value": "", "type": "query", "description": "Number of data members to be displayed per page. The default value is `1000` and the maximum value is `5000`." }, { "name": "startDate", "value": "", "type": "query", "description": "Inclusive start date that's being used to filter the data members. This applies to subscribe date when retrieving subscribed contacts. Applies to unsubscribe date when retrieving unsubscribed contacts." }, { "name": "endDate", "value": "", "type": "query", "description": "Inclusive (exclusive when `useOriginalSubscribeDate` is `false`) end date that's being used to filter the data members. This applies to subscribe date when retrieving subscribed contacts. Applies to unsubscribe date when retrieving unsubscribed contacts." }, { "name": "useOriginalSubscribeDate", "value": "", "type": "query", "description": "Whether the `startDate` and `endDate` use the contact's original subscribe date or the contact's most recent subscribe date. Only applies when `subscriptionState` is `Subscribed`. The default value is `true`." } ] }, "docs": "Returns the collection of contacts associated with the specified list." }, { "info": { "name": "Create or update a Contact", "type": "http" }, "http": { "method": "POST", "url": "https://api.listrak.com/crosschannel/v1/v1/List/:listId/Contact", "params": [ { "name": "listId", "value": "", "type": "path", "description": "Identifier used to locate the list." }, { "name": "eventIds", "value": "", "type": "query", "description": "Comma-separated list of event identifiers that should be raised after the contact is created or updated." }, { "name": "overrideUnsubscribe", "value": "", "type": "query", "description": "Whether a contact in an unsubscribed state should be forced to a subscribed state. The default value is `false`." }, { "name": "subscribedByContact", "value": "", "type": "query", "description": "Whether the subscribe was initiated by the contact. The default value is `false`." }, { "name": "sendDoubleOptIn", "value": "", "type": "query", "description": "Whether a double opt-in email should be sent if a new contact is being created. The default value is `false`." }, { "name": "updateType", "value": "", "type": "query", "description": "If updating an existing contact, the type of update that will be performed on any submitted profile fields. Allowed values are `Update`, `Append`, and `Overwrite`. The default value is `Update`." }, { "name": "newEmailAddress", "value": "", "type": "query", "description": "If updating an existing contact, the contact's email address will be changed to this value. Provide the original email address in the `emailAddress` body field to select the existing contact." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a contact on the specified list." }, { "info": { "name": "Get a Contact", "type": "http" }, "http": { "method": "GET", "url": "https://api.listrak.com/crosschannel/v1/v1/List/:listId/Contact/:contactIdentifier", "params": [ { "name": "listId", "value": "", "type": "path", "description": "Identifier used to locate the list." }, { "name": "contactIdentifier", "value": "", "type": "path", "description": "Identifier used to locate the contact. You may specify either an email address or a Listrak email key." }, { "name": "segmentationFieldIds", "value": "", "type": "query", "description": "Comma-separated list of profile field IDs to retrieve. Up to 30 fields may be included." } ] }, "docs": "Returns a contact by email address or by Listrak email key." }, { "info": { "name": "Get Contact Collection", "type": "http" }, "http": { "method": "GET", "url": "https://api.listrak.com/crosschannel/v1/v1/ShortCode/:senderCodeId/PhoneList/:phoneListId/Contact", "params": [ { "name": "senderCodeId", "value": "", "type": "path", "description": "Identifier used to specify the Sender Code." }, { "name": "phoneListId", "value": "", "type": "path", "description": "Identifier used to locate the SMS List." }, { "name": "optedOut", "value": "", "type": "query", "description": "Determines the status of contacts on the resulting data. The default value is `false`." }, { "name": "cursor", "value": "", "type": "query", "description": "Value indicating the page of data that's being retrieved. The default value is `Start`." }, { "name": "count", "value": "", "type": "query", "description": "Number of data members to be displayed per page. The default value is `1000` and the maximum value is `5000`." }, { "name": "startSubscribeDate", "value": "", "type": "query", "description": "Start date that's being used to filter the data members. This applies to subscribe date." }, { "name": "endSubscribeDate", "value": "", "type": "query", "description": "End date that's being used to filter the data members. This applies to subscribe date." } ] }, "docs": "Returns all contacts that exist on a specific SMS list by optout status." }, { "info": { "name": "Create Contact", "type": "http" }, "http": { "method": "POST", "url": "https://api.listrak.com/crosschannel/v1/v1/ShortCode/:senderCodeId/PhoneList/:phoneListId/Contact", "params": [ { "name": "senderCodeId", "value": "", "type": "path", "description": "Identifier used to specify the Sender Code." }, { "name": "phoneListId", "value": "", "type": "path", "description": "Identifier for the SMS List that the contact will be created on." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and subscribes a new contact for a phone number if the contact does not already exist on the sender code.\r\nThis call will create a record of the contact as well as subscribe the contact to the list that was passed in the route.\r\nChanges to segmentation fields apply to the contact across all sender codes." }, { "info": { "name": "Get Contact", "type": "http" }, "http": { "method": "GET", "url": "https://api.listrak.com/crosschannel/v1/v1/ShortCode/:senderCodeId/Contact/:phoneNumber", "params": [ { "name": "senderCodeId", "value": "", "type": "path", "description": "Identifier used to specify the Sender Code." }, { "name": "phoneNumber", "value": "", "type": "path", "description": "Phone number for contact." } ] }, "docs": "Returns a contact for a phone number. The response does not include a list id. This call will only return the system and custom profile fields for a contact along with the opted out status." }, { "info": { "name": "Update Contact", "type": "http" }, "http": { "method": "PUT", "url": "https://api.listrak.com/crosschannel/v1/v1/ShortCode/:senderCodeId/Contact", "params": [ { "name": "senderCodeId", "value": "", "type": "path", "description": "Identifier used to specify the Sender Code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a contact's information for a phone number. \r\nThis call will update the system fields, custom profile fields, and the opt-out status of a contact.\r\nIt is only possible to opt out a contact using this call; not opting them in to the sender code. \r\nIf a contact is opted out, it is still possible to update the contacts system and custom profile fields.\r\nChanges to segmentation fields apply to the contact across all sender codes." }, { "info": { "name": "Get Sender Code Opt-Outs", "type": "http" }, "http": { "method": "GET", "url": "https://api.listrak.com/crosschannel/v1/v1/ShortCode/:senderCodeId/OptOut", "params": [ { "name": "senderCodeId", "value": "", "type": "path", "description": "Identifier used to specify the Sender Code." }, { "name": "cursor", "value": "", "type": "query", "description": "Value indicating the page of data that's being retrieved. The default value is `Start`." }, { "name": "count", "value": "", "type": "query", "description": "Number of data members to be displayed per page. The default value is `1000` and the maximum value is `5000`." }, { "name": "startDate", "value": "", "type": "query", "description": "Start date that's being used to filter the data members. This applies to opt-out date." }, { "name": "endDate", "value": "", "type": "query", "description": "End date that's being used to filter the data members. This applies to opt-out date." } ] }, "docs": "Returns all contacts that have been opted-out for a specific SMS Sender Code" }, { "info": { "name": "Start a Contact Update Import", "type": "http" }, "http": { "method": "POST", "url": "https://api.listrak.com/crosschannel/v1/v1/ShortCode/:senderCodeId/ContactImport", "params": [ { "name": "senderCodeId", "value": "", "type": "path", "description": "Identifier used to locate the sender code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and starts a new update import for the specified sender code. HTTP request body lengths of up to 250 MB are permitted. Because the `fileStream` field must be encoded in Base64, and because the remainder of the JSON payload is counted against the 250 MB limit, the effective maximum import file size is approximately 185 MB (195,000,000 bytes); therefore, only attempt to import files up to 185 MB (195,000,000 bytes) in size." }, { "info": { "name": "Get a Contact Import", "type": "http" }, "http": { "method": "GET", "url": "https://api.listrak.com/crosschannel/v1/v1/ShortCode/:senderCodeId/ContactImport/:importFileId", "params": [ { "name": "senderCodeId", "value": "", "type": "path", "description": "Identifier used to locate the sender code." }, { "name": "importFileId", "value": "", "type": "path", "description": "Identifier used to locate the import file." } ] }, "docs": "Retrieves the specified Contact import." } ] } ], "bundled": true }