Yulsn Api - Documentation

Will return all actions

Will trigger action by id on contact. Action must be trigger-able manually and be enabled

Will trigger action by id on segment. Action must be trigger-able manually and be enabled

Requests a cache reset for the specified banners. Will return HTTP 200 or HTTP 404 if banner is not found.

Requests a cache reset for a list of banner version. Will return HTTP 200 or HTTP 404 if banner is not found.

Will return bulk exports by its type or all if none provided.

No documentation available.

Get all ContactCompanies

A list of ContactCompanies where the Contact with the provided email address is primary contact.

Get a ContactCompany using ContactCompanyNumber (An external unique identifier of the company)

Get a ContactCompany

Gets a list of Contacts associated with the ContactCompany If the ContactCompany has no Contacts associated a HTTP 404 is returned

Creates a ContactCompany

Associates a Contact with a ContactCompany

Removes a Contact's association with a ContactCompany

Patch ContactCompany by id, only fields in the request are updated

Retrieve array of events with id higher than provided lastId and specified type. A maximum of 1000 events are returned

Will get events by type.

Will create new events for contacts with specified information. Will return HTTP 404 if a contact with given Id is not found.

Returns all contactIds in system

Will return contact by its email or HTTP 404 if contact is not found.

Will return contact by its phone or HTTP 404 if contact is not found.

Will return contact by its secret or HTTP 404 if contact is not found.

Will return array of contacts by dynamic field or empty array if no contacts are found.

Will return contact by its id or HTTP 404 if contact is not found.

Will return a list of contact fields which can be PATCHed on a batch of contacts.

Will get Account specific fields. The fields will be valid to use in all requests, but will not be shown in the documentation, because it is account wide documentation.

Returns basic info about all contacts in the system.

Will return array of registered contacts by Registration timespan, RegistrationSource or RegistrationIp (can combine). Will return empty array if nothing is found.

Will return url of person data file

Will create new contact with specified information. If contact with same Name or same Phone number exists then HTTP 409 will be returned. If no Store with PreferredStoreId exists then HTTP 409 will be returned.

Validates a password for a specific user. Will return contact or HTTP 404 if contact is not found.

Sets the password for a user. Will return HTTP 200 or HTTP 404 if contact is not found.

Unblocks a contact that is bounced by email. Returns false if the contact is not bounced by email.

Will update contact identified by id with specified information. If contact has been modified (concurrent update) since it has been retrieved then HTTP 409 will be returned with latest contact information. If another contact with same Email or Phone is found then HTTP 409 will be returned with latest contact information for specified contact. If no Store with PreferredStoreId exists then HTTP 409 will be returned.

Will PATCH the given {Fields} on contacts by the given {Keys}.

Will patch contact object with given values. Only updates contact properties that are not null in patchContactDto. All other properties are left unchanged. NOTE: The following properies will be set to null if the patch value is "" (empty string): PhoneCountryCode, Phone and Email

Will delete contact with specified id.

Returns a List of raw json stats from a daterange

Returns a list of emailstats from a daterange

Returns a list of contactstats for new contacts from a daterange

Returns a list of contactstats for deleted contacts from a daterange

Returns a List of listlog stats from a daterange

Returns a list of SegmentStat for a single day in a month. Will use the latest day in the month where stats are availeble

Returns a list of ContactPermissionSourceStats from a month

Returns a list of ContactPermissionSourceStats from a daterange

Returns a list of ContactPermissionSourceStats from a month

Retrieve array of dynamic fields by owner.

Will return all {tableName} entity ids

Will return {tableName} entity by secret or HTTP 404.

Will return {tableName} entity by external id or HTTP 404

Will return {tableName} entities with id higher than provided lastId up to limit

Will return {tableName} entity by id or HTTP 404

Will create new {tableName} entity. Returns HTTP 423 if the request must be made through a converter.

Will create new {tableName} entities. Returns HTTP 423 if the request must be made through a converter.

Will update {tableName} entity. Returns HTTP 423 if the request must be made through a converter.

Will delete {tableName} entity. Returns HTTP 423 if the request must be made through a converter.

Retrieve array of dynamic tables.

Will create an email2 dispatch. An id will only be returned if the scope is using segments.

Create an Email Builder Campaign

Cancel a scheduled EmailBuilderCampaign

Add an Email Builder Block to an Email Builder Campaign

Schedule an Email Builder Campaign

Will return an array of email dispatches

Will create an email dispatch

Retrieve array of EmailDispatchReceivers with ids created after the provided lastId. A maximum of around 1000 are returned - so if you get 1000 or more back you should ask again with your new lastId

Retrieve a EmailDispatchReceiver with matching email dispatch id and contact id

Will trigger a feed sync to sync now.

Get an IframeToken

Returns a list of Media in the requested folder.

Returns a single Media item.

Returns a list of media folders

Creates a new Media

Rename a Media

Delete media with specified id.

Retrieve array of orders by contact id.

Retrieve orders by extOrderId

Retrieve order by id

Retrieve array of valid order types.

Create new order with the specified information. Will return HTTP 400 on missing or invalid orderlines, and on invalid order type.

Create new order line with the specified information. Will return HTTP 404 on missing order and HTTP 400 on invalid order line.

Patch order by id, only fields in the request are updated

Patch order line by id, only fields in the request are updated. Will return HTTP 404 on invalid order or order line ids.

Delete order by id. Will return HTTP 404 on missing order.

Delete order line. Will return HTTP 404 on missing order or missing order line and HTTP 400 on invalid operation on order (the last order line cannot be deleted, delete order instead).

Retrieve array of permission source categories

Retrieve array of permission source categories

Retrieve array of points with id higher than provided lastId and with optional specified type. A maximum of 1000 points are returned

Retrieve array of points with specified source id.

Retrieve array of points within the datetime from(including) and to with specified type and (optional) storeId.

Retrieve array of points for specified contact.

Retrieve a point by id

Retrieve array of valid point types.

Retrieve array of pointtotals.

Retrieve array of pointsums for specified contact.

Retrieve array of pointsums of a specific type of points for all contacts.

Retrieve array of pointstoresums of a specific type of points for all stores within an optional timeframe

Retrieve sum of points of a certain type and subtype for specified contact

Retrieve array of ContactCompany sums within the datetime from(including) and to - with specified type and (optional) storeId.

Retrieve sum for a ContactCompany - within the datetime from (including) and to - with specified type. If no point exist - NULL is returned.

Retrieve array of points for the specified ContactCompany - within the datetime from(including) and to - with specified type and storeId.

Will create new point for contact with specified information. Will return HTTP 404 if contact with given Id is not found.

Cancel a point

Retrieve array of points within the datetime from(including) and to with specified type and associated with one of stores in the list.

Retrieve array of point sums for stores grouped by ContactCompanies within the datetime from (including) and to - with specified type.

Returns an list of segments based on folderId

Returns a Contact count based on a list of segmentIds

Returns a list of contactIds from a segment

Returns a list of contactEmails from a segment

Creates a segment based on a list of contactIds

Returns a Contact count based on a list of segmentIds

Will return speciffic store by number

Get all Stores for an account.

Will return speciffic store by id

Will create a new store

Patch Store by id, only fields in the request are updated