Paloma

Paloma Support

Du är här: Start / API

Paloma Contact API documentation

Uppdaterad

Contacts

API for managing contacts and related resources.                                                                                                       

HTTP methodRelative pathDescription
GETApi/Contact?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/Contact/{id}

Get item with specified id.

POSTApi/Contact

Create a new item.

PUTApi/Contact

Update item.

DELETEApi/Contact/{id}

Delete item with specified id.

GETApi/Contact/count

Get the number of items.

GETApi/Contact/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/Contact/groupby/{groupBy}/count

Get the number of groups produced by group by.

GETapi/Contact/GetByPrimaryFieldValue?primaryFieldValue={primaryFieldValue}

Get contact by primary field value instead of id.

GETapi/Contact/GetByGuid?guid={guid}

Get contact by guid.

GETapi/Contact/GetFlatContact?id={id}

Get contact with contact field values as properties directly on the contact object. Property names for contact field values are the contact fields FiledKey. {Id, CustomerId, OwnerId  ...{ContactFieldKey: ContactFieldValue, ...}}

GETapi/Contact/GetFlatContactByPrimaryFieldValue?primaryFieldValue={primaryFieldValue}

Get contact with contact field values as properties directly on the contact object. Property names for contact field values are the contact fields FiledKey. {Id, CustomerId, OwnerId ...{ContactFieldKey: ContactFieldValue, ...}}

GETapi/Contact/GetFlatContactByGuid?guid={guid}

Get contact with contact field values as properties directly on the contact object. Property names for contact field values are the contact fields FiledKey. {Id, CustomerId, OwnerId ...{ContactFieldKey: ContactFieldValue, ...}}

POSTApi/Contact/RegisterNewContact

Registers a new contact. Can also register it to specific contact lists at the same time (optional).

PUTApi/Contact?primaryFieldValue={primaryFieldValue}

Update a contact identified with primary field value instead of contact id.

PUTApi/Contact/RegisterContactInSegments

Register at existing contact to specific contact segments (contact lists). Use the RegisterNewContact action if the contact doesn't exist yet.

PUTApi/Contact/UpdateContactData

Update contact data by using contact field keys. The contact is speciefied by the value of the primary field in the FieldValues. For example: if the primary field on the account is email, the email value will specify which contact will be updated.

PUTApi/Contact/UnregisterContact

Unregisters a contact from specific contact segments (contacts lists) or the whole account.

DELETEapi/Contact/DeleteByPrimaryFieldValue?primaryFieldValue={primaryFieldValue}

Delete contact by primary field value insetead of id.

GETApi/Contact/count?filteringdto={filteringdto}

Get the number of items

ContactMailing

Contact mailing is the base class for different types of mailings (like NewsletterMailing). It can be used for fetching statistics for completed mailings, but for sending mailings yo need to use the base classes. The special methods can also be used to control the sending process.

HTTP methodRelative pathDescription
GETapi/ContactMailing/HasContactRecievedMailing?contactId={contactId}&mailingId={mailingId}

Get multiple items.

GETapi/ContactMailing/HasContactOpenedMailing?contactId={contactId}&mailingId={mailingId}

Get multiple items.

GETapi/ContactMailing/HasContactClickedLinkInMailing?contactId={contactId}&mailingId={mailingId}&linkId={linkId}

Get multiple items.

GETapi/ContactMailing/GetCustomerMailingTypesInfo

Get item with specified id.

GETApi/ContactMailing?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailing/{id}

Get item with specified id.

GETApi/ContactMailing/{id}/Stop

Get item with specified id.

GETApi/ContactMailing/{id}/Resume

Get item with specified id.

GETApi/ContactMailing/{id}/MoveToFinished

Get item with specified id.

POSTApi/ContactMailing

Create a new item.

PUTApi/ContactMailing

Update item.

PUTApi/ContactMailing/AddContactToContinuousMailing

Update item.

DELETEApi/ContactMailing/{id}

Delete item with specified id.

GETApi/ContactMailing/count

Get the number of items.

GETApi/ContactMailing/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailing/groupby/{groupBy}/count

Get the number of groups produced by group by.

POSTApi/ContactMailing/SendMailingFromTemplate

Creates a mailing from a ContactMailingTemplate that has a matching NewsletterMailingTemplateId.

ContactMailingLinkClickGroup

Grouped link clicks for each recipient and link.                                                                                                            

HTTP methodRelative pathDescription
GETApi/ContactMailingLinkClickGroup?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailingLinkClickGroup/{id}

Get item with specified id.

POSTApi/ContactMailingLinkClickGroup

Create a new item.

PUTApi/ContactMailingLinkClickGroup

Update item.

DELETEApi/ContactMailingLinkClickGroup/{id}

Delete item with specified id.

GETApi/ContactMailingLinkClickGroup/count

Get the number of items.

GETApi/ContactMailingLinkClickGroup/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingLinkClickGroup/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactMailingItemOpen

ContactMailingItemOpen represents when a recipient opened their email. If a recipient opened the email multiple times there will be a ContactMailingItemOpen for each time. 

HTTP methodRelative pathDescription
GETApi/ContactMailingItemOpen?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailingItemOpen/{id}

Get item with specified id.

POSTApi/ContactMailingItemOpen

Create a new item.

PUTApi/ContactMailingItemOpen

Update item.

DELETEApi/ContactMailingItemOpen/{id}

Delete item with specified id.

GETApi/ContactMailingItemOpen/count

Get the number of items.

GETApi/ContactMailingItemOpen/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingItemOpen/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactMailingItemBounce

Bounces that occured when a contact mailing was sent.                                                    

HTTP methodRelative pathDescription
GETApi/ContactMailingItemBounce/{id}

Get item with specified id.

POSTApi/ContactMailingItemBounce

Create a new item.

PUTApi/ContactMailingItemBounce

Update item.

DELETEApi/ContactMailingItemBounce/{id}

Delete item with specified id.

GETApi/ContactMailingItemBounce/count

Get the number of items.

GETApi/ContactMailingItemBounce/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingItemBounce/groupby/{groupBy}/count

Get the number of groups produced by group by.

GETApi/ContactMailingItemBounce?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get a list of unregistrations. Possible filters: fromdate, todate, contactmailingid, type.            The type filter can be 1-4 or a comma separated string of multiple values between 1-4.            Bounce types: Soft = 1, Hard = 2, Block = 3, FeedbackLoop = 4

ContactMailingLink

Links that are present in a contact mailing.

HTTP methodRelative pathDescription
GETApi/ContactMailingLink?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailingLink/{id}

Get item with specified id.

POSTApi/ContactMailingLink

Create a new item.

PUTApi/ContactMailingLink

Update item.

DELETEApi/ContactMailingLink/{id}

Delete item with specified id.

GETApi/ContactMailingLink/count

Get the number of items.

GETApi/ContactMailingLink/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingLink/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactSegmentUserAccountAccess

Represents a UserAccount that have access to a contact segment.

HTTP methodRelative pathDescription
GETApi/ContactSegmentUserAccountAccess/count

Get the number of items.

GETApi/ContactSegmentUserAccountAccess?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get the number of items.

GETApi/ContactSegmentUserAccountAccess/{id}

Get the number of items.

POSTApi/ContactSegmentUserAccountAccess

Create a new item.

PUTApi/ContactSegmentUserAccountAccess

Update item.

DELETEApi/ContactSegmentUserAccountAccess/{id}

Delete item with specified id.

GETApi/ContactSegmentUserAccountAccess/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactSegmentUserAccountAccess/groupby/{groupBy}/count

Get the number of groups produced by group by.

Statistics

A summary of recent activity in Paloma. Used by our dashboard and may be changed in the future. We do not reccomend that you use this. 

HTTP methodRelative pathDescription
GETApi/Statistics?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/Statistics/{id}

Get item with specified id.

POSTApi/Statistics

Create a new item.

PUTApi/Statistics

Update item.

DELETEApi/Statistics/{id}

Delete item with specified id.

GETApi/Statistics/count

Get the number of items.

GETApi/Statistics/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/Statistics/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactField

Contact fields belongs to your account and defines what fields you want to save on your contacts.

HTTP methodRelative pathDescription
GETApi/ContactField?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactField/{id}

Get item with specified id.

POSTApi/ContactField

Create a new item.

PUTApi/ContactField

Update item.

DELETEApi/ContactField/{id}

Delete item with specified id.

GETApi/ContactField/count

Get the number of items.

GETApi/ContactField/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactField/groupby/{groupBy}/count

Get the number of groups produced by group by.

PUTApi/ContactField/RearrangeContactFields

Update SortIndexes for given ContactFields. Key = ContactFieldId. Value = new SortIndex.

ContactMailingStatistics

Statistics summary for a contact mailings.

HTTP methodRelative pathDescription
GETApi/ContactMailingStatistics?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailingStatistics/{id}

Get item with specified id.

POSTApi/ContactMailingStatistics

Create a new item.

PUTApi/ContactMailingStatistics

Update item.

DELETEApi/ContactMailingStatistics/{id}

Delete item with specified id.

GETApi/ContactMailingStatistics/count

Get the number of items.

GETApi/ContactMailingStatistics/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingStatistics/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactSegment

Contact segments are segments of the contacts on the account. In the GUI they are reffered to as contact lists.     In the future there will probably be contact segments that are dynamic and are based on contact filters.

HTTP methodRelative pathDescription
GETApi/ContactSegment?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactSegment/{id}

Get item with specified id.

POSTApi/ContactSegment

Create a new item.

PUTApi/ContactSegment

Update item.

DELETEApi/ContactSegment/{id}

Delete item with specified id.

GETApi/ContactSegment/count

Get the number of items.

GETApi/ContactSegment/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactSegment/groupby/{groupBy}/count

Get the number of groups produced by group by.

POSTApi/ContactSegment/GetContactSegmentWithFilteredContacts

Get contact segments where the contact count is calculated with contacts not valid of sending filtered out.

DELETEApi/ContactSegment/{id}/DeleteContactsOnSegment

Deletes a list of contacts from a segment. Warning! If you set no id, it will delete the contacts from the whole account! Warning! If you set an id but no contactIds it will delete all contacts, which are in the list, from the whole account! Note: This method will time out if there are to many contactIds.

Terms    

Terms texts that can be used to gather consent (for GDPR) from contacts.

HTTP methodRelative pathDescription
GETApi/Terms?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/Terms/{id}

Get item with specified id.

POSTApi/Terms

Create a new item.

PUTApi/Terms

Update item.

DELETEApi/Terms/{id}

Delete item with specified id.

GETApi/Terms/count

Get the number of items.

GETApi/Terms/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/Terms/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactUserAccountAccess

HTTP methodRelative pathDescription
GETApi/ContactUserAccountAccess/count

Get the number of items.

GETApi/ContactUserAccountAccess?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get the number of items.

GETApi/ContactUserAccountAccess/{id}

Get the number of items.

POSTApi/ContactUserAccountAccess

Create a new item.

PUTApi/ContactUserAccountAccess

Update item.

DELETEApi/ContactUserAccountAccess/{id}

Delete item with specified id.

GETApi/ContactUserAccountAccess/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactUserAccountAccess/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactSegmentAccess

Contains access information for contact segment (contact list).

HTTP methodRelative pathDescription
GETApi/ContactSegmentAccess?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactSegmentAccess/{id}

Get item with specified id.

POSTApi/ContactSegmentAccess

Create a new item.

PUTApi/ContactSegmentAccess

Update item.

DELETEApi/ContactSegmentAccess/{id}

Delete item with specified id.

GETApi/ContactSegmentAccess/count

Get the number of items.

GETApi/ContactSegmentAccess/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactSegmentAccess/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactImport

A contact import is a bulk action that can handle a lot of contacts at once. Check the ContactImportMode property to see what bulk actions are available.

HTTP methodRelative pathDescription
GETApi/ContactImport?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactImport/{id}

Get item with specified id.

POSTApi/ContactImport

Create a new item.

PUTApi/ContactImport

Update item.

DELETEApi/ContactImport/{id}

Delete item with specified id.

GETApi/ContactImport/count

Get the number of items.

GETApi/ContactImport/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactImport/groupby/{groupBy}/count

Get the number of groups produced by group by.

GETApi/ContactImport/{id}/Stop

Stop contact import.

GETApi/ContactImport/{id}/Dismiss

Dismiss contact import from the active tasks popup in the user interface.

POSTApi/ContactImport/UploadFile

Upload and parse an excel file to get data to use for creating a contact import.

ContactMailingDevicesStatistics

Contains device statistics for completed contact mailings.

HTTP methodRelative pathDescription
GETApi/ContactMailingDevicesStatistics?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailingDevicesStatistics/{id}

Get item with specified id.

POSTApi/ContactMailingDevicesStatistics

Create a new item.

PUTApi/ContactMailingDevicesStatistics

Update item.

DELETEApi/ContactMailingDevicesStatistics/{id}

Delete item with specified id.

GETApi/ContactMailingDevicesStatistics/count

Get the number of items.

GETApi/ContactMailingDevicesStatistics/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingDevicesStatistics/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactImportLogRow

Log rows for contact import that contains information about import rows that failed for some reason.



Description
GETApi/ContactImportLogRow?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactImportLogRow/{id}

Get item with specified id.

POSTApi/ContactImportLogRow

Create a new item.

PUTApi/ContactImportLogRow

Update item.

DELETEApi/ContactImportLogRow/{id}

Delete item with specified id.

GETApi/ContactImportLogRow/count

Get the number of items.

GETApi/ContactImportLogRow/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactImportLogRow/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactMailingItemStatistics

Statistics summary for a contact mailing item (a recipient).

HTTP methodRelative pathDescription
GETApi/ContactMailingItemStatistics?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailingItemStatistics/{id}

Get item with specified id.

POSTApi/ContactMailingItemStatistics

Create a new item.

PUTApi/ContactMailingItemStatistics

Update item.

DELETEApi/ContactMailingItemStatistics/{id}

Delete item with specified id.

GETApi/ContactMailingItemStatistics/count

Get the number of items.

GETApi/ContactMailingItemStatistics/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingItemStatistics/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactMailingTemplateLink

Links that are present in a contact mailing.

HTTP methodRelative pathDescription
GETApi/ContactMailingTemplateLink?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailingTemplateLink/{id}

Get item with specified id.

POSTApi/ContactMailingTemplateLink

Create a new item.

PUTApi/ContactMailingTemplateLink

Update item.

DELETEApi/ContactMailingTemplateLink/{id}

Delete item with specified id.

GETApi/ContactMailingTemplateLink/count

Get the number of items.

GETApi/ContactMailingTemplateLink/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingTemplateLink/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactFieldValue

Contact field values holds the values for the contact fields on each contact.                           

HTTP methodRelative pathDescription
GETApi/ContactFieldValue?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactFieldValue/{id}

Get item with specified id.

POSTApi/ContactFieldValue

Create a new item.

PUTApi/ContactFieldValue

Update item.

DELETEApi/ContactFieldValue/{id}

Delete item with specified id.

GETApi/ContactFieldValue/count

Get the number of items.

GETApi/ContactFieldValue/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactFieldValue/groupby/{groupBy}/count

Get the number of groups produced by group by.

PUTApi/ContactFieldValue/SetContactFieldValue

Set contact field value for specific contact

ContactMailingTemplate

Contact mailing is the base class for different types of mailings (like NewsletterMailing). It can be used for fetching statistics for completed mailings, but for sending mailings yo need to use the base classes. The special methods can also be used to control the sending process.                        

HTTP methodRelative pathDescription
GETApi/ContactMailingTemplate?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailingTemplate/{id}

Get item with specified id.

POSTApi/ContactMailingTemplate

Create a new item.

PUTApi/ContactMailingTemplate

Update item.

DELETEApi/ContactMailingTemplate/{id}

Delete item with specified id.

GETApi/ContactMailingTemplate/count

Get the number of items.

GETApi/ContactMailingTemplate/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingTemplate/groupby/{groupBy}/count

Get the number of groups produced by group by.

UserAccount

User accounts that have a login to the system. This resource in this API can only be used for getting a simple list of the users. POST, PUT and DELETE wont work, but are present due to us inheriting reusable code in the API.

HTTP methodRelative pathDescription
GETApi/UserAccount/count

Get the number of items.

GETApi/UserAccount?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get the number of items.

GETApi/UserAccount/{id}

Get the number of items.

POSTApi/UserAccount

Create a new item.

PUTApi/UserAccount

Update item.

DELETEApi/UserAccount/{id}

Delete item with specified id.

GETApi/UserAccount/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/UserAccount/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactMailingItemUnregister

Unregistrations that occured via unregistration links in the contact mailing.

HTTP methodRelative pathDescription
GETApi/ContactMailingItemUnregister/{id}

Get item with specified id.

POSTApi/ContactMailingItemUnregister

Create a new item.

POSTApi/ContactMailingItemUnregister/UnregisterRecipient

Create a new item.

PUTApi/ContactMailingItemUnregister

Update item.

DELETEApi/ContactMailingItemUnregister/{id}

Delete item with specified id.

GETApi/ContactMailingItemUnregister/count

Get the number of items.

GETApi/ContactMailingItemUnregister/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingItemUnregister/groupby/{groupBy}/count

Get the number of groups produced by group by.

GETApi/ContactMailingItemUnregister?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get a list of unregistrations.  Possible filters: fromdate, todate, contactmailingid

ContactMailingItem

ContactMailingItems represents the recipients that a contact mailing was sent to.                     

HTTP methodRelative pathDescription
GETApi/ContactMailingItem?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailingItem/{id}

Get item with specified id.

POSTApi/ContactMailingItem

Create a new item.

PUTApi/ContactMailingItem

Update item.

DELETEApi/ContactMailingItem/{id}

Delete item with specified id.

GETApi/ContactMailingItem/count

Get the number of items.

GETApi/ContactMailingItem/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingItem/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactMailingLinkClick

Link clicks by the recipients of the contact mailing. Can have muliple clicks for a link and recipient.

HTTP methodRelative pathDescription
GETApi/ContactMailingLinkClick?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactMailingLinkClick/{id}

Get item with specified id.

POSTApi/ContactMailingLinkClick

Create a new item.

PUTApi/ContactMailingLinkClick

Update item.

DELETEApi/ContactMailingLinkClick/{id}

Delete item with specified id.

GETApi/ContactMailingLinkClick/count

Get the number of items.

GETApi/ContactMailingLinkClick/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactMailingLinkClick/groupby/{groupBy}/count

Get the number of groups produced by group by.

ContactFieldType    

Contact field types are reusable field types that are used when creating contact fields.

HTTP methodRelative pathDescription
GETApi/ContactFieldType?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/ContactFieldType/{id}

Get item with specified id.

POSTApi/ContactFieldType

Create a new item.

PUTApi/ContactFieldType

Update item.

DELETEApi/ContactFieldType/{id}

Delete item with specified id.

GETApi/ContactFieldType/count

Get the number of items.

GETApi/ContactFieldType/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/ContactFieldType/groupby/{groupBy}/count

Get the number of groups produced by group by.

TermsConsent

 Represents consents given by contacts to re specific revision of a terms text (for GDPR).

HTTP methodRelative pathDescription
GETApi/TermsConsent?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/TermsConsent/{id}

Get item with specified id.

POSTApi/TermsConsent

Create a new item.

PUTApi/TermsConsent

Update item.

DELETEApi/TermsConsent/{id}

Delete item with specified id.

GETApi/TermsConsent/count

Get the number of items.

GETApi/TermsConsent/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/TermsConsent/groupby/{groupBy}/count

Get the number of groups produced by group by.

TermsRevision

Revisions of terms texts that are used to gather consent (fro GDPR) from contacts.

HTTP methodRelative pathDescription
GETApi/TermsRevision?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get multiple items.

GETApi/TermsRevision/{id}

Get item with specified id.

POSTApi/TermsRevision

Create a new item.

PUTApi/TermsRevision

Update item.

DELETEApi/TermsRevision/{id}

Delete item with specified id.

GETApi/TermsRevision/count

Get the number of items.

GETApi/TermsRevision/groupby/{groupBy}?skip={skip}&take={take}&orderBy={orderBy}&desc={desc}

Get items grouped by specific parameter.

GETApi/TermsRevision/groupby/{groupBy}/count

Get the number of groups produced by group by.

Guide taggad med: API dokumentation Integrera Integration

Fick du svar på din fråga?

warning Created with Sketch.