Use the type DELETE_DATA_DOCS_FILE to delete multiple documents in one job.
You can either delete by exteranlId or original id, method is defined by deleteMethod when initiating the batch job.
Note that all documents for an original id will be deleted when using deleteMethod DELETE_BY_ORIGINAL_ID.
File structure example:
\n{\"ticketId\":\"62\"}\n{\"ticketId\":\"61\"}\n\nYou may now upload the contact file using a PUT to the uploadUrl specified in the previous response.
\nThe batch will start within seconds after the file has been uploaded.
\nPlease note:
\n- \n
- The value of Content-Type header should be text/plain \n
- The uploaded file should be UTF-8 encoded. \n
- The uploadUrl is valid for 12 hours. \n
- The file must be publically available for download. For this reason, it is recommended that it's protected using a secure, time-based signature. \n
Returns the information about all your Document Types, including the mapping structure.
\n","urlObject":{"path":["{{customerId}}","datadocs","documenttype"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e45d4101-c77d-4017-b7dc-8dbc1067a655"},{"name":"Get document type by id","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"e7a1b266-afc2-4e11-a339-f2baf76f26f6"}}],"id":"3dae5c9d-bea8-4aa3-9c99-a80e154054a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/datadocs/documenttype/{documentTypeId}","description":"Returns information about the specific Document Type, including mapping structure.
\n","urlObject":{"path":["{{customerId}}","datadocs","documenttype","{documentTypeId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1e5e4f6e-e5eb-4605-a866-0dae5bae96e6","name":"Get document type by id","originalRequest":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/datadocs/documenttype/30"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 29 Mar 2023 08:28:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"documentTypeId\": 30,\n \"customerId\": 509,\n \"name\": \"Events SE\",\n \"originalIdAttribute\": \"originalId\",\n \"externalIdAttribute\": \"bookingnumber\",\n \"description\": \"All bookings Sweden\",\n \"jsonSchema\": \"\",\n \"validateSchema\": false\n}"}],"_postman_id":"3dae5c9d-bea8-4aa3-9c99-a80e154054a5"},{"name":"Create document type","event":[{"listen":"test","script":{"id":"1f6f3290-c1b1-469b-a3d0-2778ed28053f","exec":[""],"type":"text/javascript"}}],"id":"d344c870-2d41-4587-8048-ffc9458cd3e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":" {\n \"name\": \"{Document type name}\",\n \"description\": \"{Document type description}\",\n \"originalIdAttribute\": \"{docHeaderForMappingOrignalId}\",\n \"externalIdAttribute\": \"{docHeaderForMappingExternalId}\",\n \"jsonSchema\": \"\"\n }","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/datadocs/documenttype","urlObject":{"path":["{{customerId}}","datadocs","documenttype"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d344c870-2d41-4587-8048-ffc9458cd3e3"},{"name":"Update document type","event":[{"listen":"test","script":{"id":"b825651b-00b4-4f42-92e2-cc4d48eae20c","exec":[""],"type":"text/javascript"}}],"id":"ef86d4be-d64a-4da6-b2a7-2ede33c871df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"{Document type name}\",\n \"originalIdAttribute\": \"{docHeaderForMappingOrignalId}\",\n \"externalIdAttribute\": \"{docHeaderForMappingExternalId}\",\n \"description\": \"{Document type description}\",\n \"jsonSchema\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/datadocs/documenttype/{documentTypeId}","description":"Before you make your update, always fetch the document type you want to update first, make your changes and include every field in this update request.
\n","urlObject":{"path":["{{customerId}}","datadocs","documenttype","{documentTypeId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef86d4be-d64a-4da6-b2a7-2ede33c871df"},{"name":"Delete document type","event":[{"listen":"test","script":{"id":"f2bde9c0-08e2-46e2-89af-98949c872ba0","exec":[""],"type":"text/javascript"}}],"id":"4d0a6ace-1c97-4d75-816a-07fa5f0b49bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/{{customerId}}/datadocs/documenttype/{documentTypeId}","urlObject":{"path":["{{customerId}}","datadocs","documenttype","{documentTypeId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d0a6ace-1c97-4d75-816a-07fa5f0b49bb"},{"name":"Delete all documents in a DocType","event":[{"listen":"test","script":{"id":"0c2b6a44-0380-492c-bc03-d2cab760d296","exec":[""],"type":"text/javascript"}}],"id":"2a284899-0df5-410b-a570-ec91261b5e40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/{{customerId}}/datadocs/documenttype/purge/{documentTypeId}","description":"Delete all documents in a DocType.
\n","urlObject":{"path":["{{customerId}}","datadocs","documenttype","purge","{documentTypeId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5da943c7-80c5-4e9d-aaac-febf17cec997","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/{{customerId}}/datadocs/documenttype/purge/50"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 21 Dec 2023 14:17:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3960364,\n \"type\": \"UNKNOWN\",\n \"customerId\": 509,\n \"startTime\": 1703168272387,\n \"endTime\": null,\n \"affected\": 0,\n \"processed\": 0,\n \"total\": 0,\n \"status\": \"PENDING\"\n}"}],"_postman_id":"2a284899-0df5-410b-a570-ec91261b5e40"}],"id":"c54d2675-4440-46d5-ab6c-3252ad2dd275","description":"In your DataDocs central you can store one or more Document Types. A Document Type gathers DataDocs with the same content and defines the two mandatory fields (originalId and externalId) in your JSON. You will always map a DataDoc to a type.
\nMultiple types can be used if you, let's say, want to separate different markets or brands due to different setups or data sources.
\nWhen viewing a contact's DataDocs you first select the document type and all rows connected to that contact within the selected type will appear.You must create a type before you can start creating docs for your contacts.
\nDocument Types can be managed by Symplify admin users under Account Settings > (Audience) Document Types.
\n","_postman_id":"c54d2675-4440-46d5-ab6c-3252ad2dd275"}],"id":"b158d6c5-9bf3-4b33-99c6-c05a6af193e0","description":"DataDocs is a feature for storing relational data regarding your contacts, this can for example be purchase history, upcoming events or other services.
\nTerminology
\n- \n
Document type
\n
In your DataDocs central you can store one or more Document Types. A Document Type gathers DataDocs with the same content and defines the two mandatory fields (originalId and externalId) in your JSON. You will always map a DataDoc to a type.Multiple types can be used if you, let's say, want to separate different markets or brands due to different setups or data sources.
When viewing a contact's DataDocs you first select the document type and all rows connected to that contact within the selected type will appear.You must create a type before you can start creating docs for your contacts. \nDataDoc
\n
A row of data connected to a contact by original id. Must belong to a Document type. The data for a contact can be updated and/or deleted. \nOriginalId
\n
The originalId is your unique identifier for a contact in Symplify.
What field in your JSON that correspond to originalId is defined by the Document Type. \nExternalId
\n
The external Id is your own identifier for a specific DataDoc row, for example an order or booking number. It must be a unique string for that specific event. The externalId can be used for updating or deleting a doc row.
What field in your JSON that correspond to externalId is defined by the Document Type. \n
Preparations
\nDataDocs is a blank sheet when you first start so begin with defining your content.
\nThere are only two mandatory fields for each row; one field containing the original Id (string) and one field containing the external id (string), the rest of the headers are added according to what you include in your file/call.
The mandatory fields are mapped when creating the Document Type.
Important! Document headers are case sensitive and must be alphanumeric (A–Z, a–z and 0–9) and not contain any whitespaces. Underscore (_) and dash (-) are allowed.
\nDocument headers are used for visualization of data, when using placeholders and when creating segments.
\nYou can add more document headers over time but please note that already existing ones can not be edited (while the values within can).
\nThe field values can be text, dates or numbers (decimals separated with a period (.)) that can be used for segmentation and placeholders in sendouts.
A value field can also contain JSON, however that can only be used for placeholder data (and not used for segmentation).
You can include as many headers you like but have in mind that everything should be there for a reason, unnecessary data means unnecessary work for the marketers.
\nUsing DataDocs in API triggered journeys
\nDocuments that should be refered to in Journeys (in placeholders or segment splits), must be included for each contact when triggering the journey.
\nUse the documentTypeId and the externalId to point out the document(s) that should be used.
\nLearn more:
\n\n","_postman_id":"b158d6c5-9bf3-4b33-99c6-c05a6af193e0"},{"name":"Contacts","item":[{"name":"Create or update a contact","item":[{"name":"Create a new contact","id":"091f632e-0303-4259-882d-a3272ad43c05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"listId\": {listId},\n \"originalId\": \"{originalId}\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"emailAddress\": \"john@example.com\",\n \"mobileNumber\": \"123465789\",\n \"properties\": {\n \"newsletter\": \"Yes\",\n \"level\": 100\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/lists/contacts","description":"This request is used to add a new contact to a specific customer's list. The request should be made to the endpoint \"{{url}}/{{customerId}}/lists/contacts\" with the following payload in the raw request body:
\n{\n \"listId\": {listId},\n \"originalId\": \"{originalId}\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"emailAddress\": \"john@example.com\",\n \"mobileNumber\": \"123465789\",\n \"properties\": {\n \"newsletter\": \"Yes\",\n \"level\": 100\n }\n}\n\nThe response will include the details of the newly added contact, such as their unique \"id\", \"listId\", \"originalId\", \"firstName\", \"lastName\", \"emailAddress\", \"mobileNumber\", and various other properties. The \"properties\" field in the response will contain both indexed and named properties associated with the contact.
\nExample response:
\n{\n \"id\": 427427320,\n \"listId\": 24003,\n \"country\": null,\n \"originalId\": \"100100\",\n \"originalIDHashed\": 1448636000,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"emailAddress\": \"john@example.com\",\n \"mobileNumber\": \"123465789\",\n ...\n \"properties\": {\n \"5862\": \"100\",\n \"7701\": \"Yes\"\n },\n \"namedProperties\": {\n \"newsletter\": \"Yes\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"emailAddress\": \"john@example.com\",\n \"level\": \"100\",\n \"mobileNumber\": \"123465789\"\n },\n ...\n}\n\nGet status by original ID.
\n","urlObject":{"path":["{{customerId}}","lists","{{listId}}","contacts","{originalId}","subscriptionstatus"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4c01659-acd3-406b-8aae-e70eaa09708a"},{"name":"Subscription status by originalId","id":"14c24cf4-83a8-4fdd-a5d0-93e73b800e91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"status\": \"SUBSCRIBED\",\r\n \"mobileStatus\": \"SUBSCRIBED\",\r\n \"audioStatus\": \"UNSUBSCRIBED\"\r\n}"},"url":"{{url}}/{{customerId}}/lists/{{listId}}/contacts/{originalId}/subscriptionstatus","description":"Update a status by original ID.
\n","urlObject":{"path":["{{customerId}}","lists","{{listId}}","contacts","{originalId}","subscriptionstatus"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1f294a01-1809-46dc-87b2-5463d231ce90","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"status\": \"SUBSCRIBED\",\r\n \"mobileStatus\": \"SUBSCRIBED\",\r\n \"audioStatus\": \"UNSUBSCRIBED\"\r\n}"},"url":"{{url}}/{{customerId}}/lists/240147/contacts/74f35dfb-5b4eccbf08/subscriptionstatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 10 Feb 2023 13:27:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUBSCRIBED\",\n \"mobileStatus\": \"SUBSCRIBED\",\n \"audioStatus\": \"UNSUBSCRIBED\"\n}"},{"id":"5b773be9-4da3-4484-af6a-f019d053d8bf","name":"404 Not Found","originalRequest":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"status\": \"SUBSCRIBED\",\r\n \"mobileStatus\": \"SUBSCRIBED\",\r\n \"audioStatus\": \"UNSUBSCRIBED\"\r\n}"},"url":"{{url}}/{{customerId}}/lists/123456/contacts/ex12345/subscriptionstatus"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 10 Feb 2023 13:28:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"enduser not found: listId:244047 orgid:ex12345 orgid hashed:-123456789\"\n}"}],"_postman_id":"14c24cf4-83a8-4fdd-a5d0-93e73b800e91"}],"id":"f319f988-997a-4cea-85b4-7fb8777fa020","description":"To view and/or update the default subscription status of a contact.
\n","_postman_id":"f319f988-997a-4cea-85b4-7fb8777fa020"},{"name":"Temp block","item":[{"name":"Temporary block contact","id":"f7897dde-42fe-422e-8946-7a9c01bd4701","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/lists/contacts/tempblock?listid={{listId}}&searchvalue={originalId}&findby=ORIGINALID","urlObject":{"path":["{{customerId}}","lists","contacts","tempblock"],"host":["{{url}}"],"query":[{"key":"listid","value":"{{listId}}"},{"key":"searchvalue","value":"{originalId}"},{"key":"findby","value":"ORIGINALID"}],"variable":[]}},"response":[{"id":"b8ec274e-ccbf-4c75-a84c-1df3622e506f","name":"Not blocked contact","originalRequest":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/{{customerId}}/lists/contacts/tempblock?listid=240178&searchvalue=10&findby=ORIGINALID","host":["{{url}}"],"path":["{{customerId}}","lists","contacts","tempblock"],"query":[{"key":"listid","value":"240178"},{"key":"searchvalue","value":"10"},{"key":"findby","value":"ORIGINALID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 13:24:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"[]"},{"id":"5af10190-78bd-43ef-bf64-aae57a3a22c6","name":"Blocked contact","originalRequest":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/{{customerId}}/lists/contacts/tempblock?listid=240178&searchvalue=10&findby=ORIGINALID","host":["{{url}}"],"path":["{{customerId}}","lists","contacts","tempblock"],"query":[{"key":"listid","value":"240178"},{"key":"searchvalue","value":"10"},{"key":"findby","value":"ORIGINALID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 13:25:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"listId\": 240178,\n \"enduserId\": 4273724746,\n \"blockUntil\": 1702162800000,\n \"emaiAddress\": \"john.doe@example.com\",\n \"originalId\": \"10\",\n \"userModified\": \"api_user\",\n \"userCreated\": \"api_user\",\n \"dateCreated\": 1676467519263,\n \"dateModified\": 1676467519263\n }\n]"}],"_postman_id":"f7897dde-42fe-422e-8946-7a9c01bd4701"},{"name":"Set temporary block for contact","id":"9e0c6a72-4cab-45fc-8622-81abcc35f478","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"findBy\": \"ORIGINALID\",\r\n \"listId\": {{listId}},\r\n \"searchValue\": \"{originalId}\",\r\n \"blockUntil\": \"2019-12-10\"\r\n}"},"url":"{{url}}/{{customerId}}/lists/contacts/tempblock","urlObject":{"path":["{{customerId}}","lists","contacts","tempblock"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f0f0748d-4dda-4f31-a4f4-ea03eb95aaf5","name":"Set temporary block for contact","originalRequest":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"findBy\": \"ORIGINALID\",\r\n \"listId\": 240178,\r\n \"searchValue\": \"10\",\r\n \"blockUntil\": \"2023-12-10\"\r\n}"},"url":"{{url}}/{{customerId}}/lists/contacts/tempblock"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 13:25:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"affected\": 1\n}"}],"_postman_id":"9e0c6a72-4cab-45fc-8622-81abcc35f478"},{"name":"Remove temp block","id":"b1a61175-616e-4ad4-a6b4-ee5135d203dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"findBy\": \"ORIGINALID\",\r\n \"listId\": {{listId}},\r\n \"searchValue\": \"{originalId}\",\r\n \"blockUntil\": \"\"\r\n}"},"url":"{{url}}/{{customerId}}/lists/contacts/tempblock","urlObject":{"path":["{{customerId}}","lists","contacts","tempblock"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9f242613-ec6b-458d-bffc-af31415986e4","name":"Remove temp block","originalRequest":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"findBy\": \"ORIGINALID\",\r\n \"listId\": 240178,\r\n \"searchValue\": \"10\",\r\n \"blockUntil\": \"\"\r\n}"},"url":"{{url}}/{{customerId}}/lists/contacts/tempblock"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 13:27:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"affected\": 1\n}"}],"_postman_id":"b1a61175-616e-4ad4-a6b4-ee5135d203dc"}],"id":"4da42be6-b65e-4bd2-96e1-9a36b45e41dc","description":"If you want to temporary block a contact from receiving messages you can do so by using the blocking feature managed by with the API.
\nNote that this is a feature that needs activation before use. Reach out to your Success Manager to get it activated on your account.
\nWhen you block a contact you'll set an end date and until that date, no messages will be sent. You can release a block if necessary.
\nYou can also use the Event Hub for blocking contacts.
\n","_postman_id":"4da42be6-b65e-4bd2-96e1-9a36b45e41dc"},{"name":"Get messages for a contact","id":"09a1a307-07db-4b62-8b95-aca24ea53156","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/lists/{{listId}}/contacts/{{originalId}}/messages","description":"Note that you add ®ister=0 to your openInBrowserUrl value in order to avoid registering a message open. Example:/mail/OBS?muid=60e5007001977XjiaDg11969616904®ister=0
Your contacts are the heart of your business. Making sure they are updated with relevant information for your communication is of highest importance.
\n","_postman_id":"175e7784-3005-43c8-8923-02b73a609bb7"},{"name":"GDPR","item":[{"name":"All scheduled anonymizations","id":"ec549ab4-4f81-4408-847e-5a2f757317d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/batches/exports/anonymization/schedule","urlObject":{"path":["{{customerId}}","batches","exports","anonymization","schedule"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec549ab4-4f81-4408-847e-5a2f757317d1"},{"name":"Scheduled anonymization by id","id":"ef0da5f9-c679-4bae-9388-ea76387fdf24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/batches/exports/anonymization/schedule/{anonymizationId}","urlObject":{"path":["{{customerId}}","batches","exports","anonymization","schedule","{anonymizationId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef0da5f9-c679-4bae-9388-ea76387fdf24"},{"name":"Create scheduled anonymization","event":[{"listen":"test","script":{"id":"d034fa16-1a68-45cd-bb00-ac860e28c995","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"anonymizationId\", jsonData.id);"],"type":"text/javascript"}}],"id":"76e7680e-ecd0-4768-86ab-9d0da03699e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"schedule\": \"0 0 12 1 * ?\",\r\n \"enabled\": true,\r\n \"config\": {\r\n \"exportStrategy\": \"ALL_CONTACTS_IN_LIST\",\r\n \"entityIds\": [\r\n \t23686\r\n ],\r\n \"columns\": [\r\n \"contact.emailaddress\",\r\n \"contact.originalid\",\r\n \"contact.id\",\r\n \"contactdb.id\"\r\n ],\r\n \"headers\": [\r\n \"contact.emailaddress\",\r\n \"contact.originalid\",\r\n \"contact.id\",\r\n \"contactdb.id\"\r\n ],\r\n \"useCompression\": false,\r\n \"exportFormat\": \"CSV\",\r\n \"period\": \"ALL\",\r\n \"uploadToFtp\": false,\r\n \"ruleJson\": \"{\\\"type\\\":\\\"LOGICAL\\\",\\\"operator\\\":\\\"AND\\\",\\\"id\\\":\\\"u_48\\\",\\\"elements\\\":[{\\\"name\\\":7429,\\\"operator\\\":\\\"EQUALS\\\",\\\"values\\\":[\\\"rm\\\"],\\\"valueType\\\":\\\"0\\\",\\\"type\\\":\\\"PROPERTY\\\",\\\"property\\\":7429,\\\"id\\\":\\\"u_161\\\",\\\"valueFormat\\\":\\\"DEFAULT\\\"}]}\",\r\n \"sendEmailOnCompletion\": false,\r\n \"userToNotify\": \"jesper@symplify.com\",\r\n \"batchDescription\": \"GDPR\",\r\n \"uploadToGoogleAudience\": false,\r\n \"uploadToFacebookAudience\": false,\r\n \"actions\": [\r\n \"ANONYMIZE\"\r\n ]\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/batches/exports/anonymization/schedule","description":"\n\n","urlObject":{"path":["{{customerId}}","batches","exports","anonymization","schedule"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"76e7680e-ecd0-4768-86ab-9d0da03699e0"},{"name":"Anonymize contact","id":"2687adf6-113c-4c5a-bf7e-cc144c5e1494","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"findBy\": \"ORIGINALID\",\r\n \"listId\": {{listId}},\r\n \"searchValue\": \"{originalId}\"\r\n}"},"url":"{{url}}/{{customerId}}/lists/contacts/anonymization","urlObject":{"path":["{{customerId}}","lists","contacts","anonymization"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2687adf6-113c-4c5a-bf7e-cc144c5e1494"},{"name":"Update scheduled anonymization","id":"8dd7ec2d-0c77-46a9-8e03-32c7ad1f25f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"id\": {anonymizationId},\r\n \"schedule\": \"0 0 12 1 * ?\",\r\n \"enabled\": true,\r\n \"config\": {\r\n \"exportStrategy\": \"ALL_CONTACTS_IN_LIST\",\r\n \"entityIds\": [\r\n 23686\r\n ],\r\n \"columns\": [\r\n \"contact.emailaddress\",\r\n \"contact.originalid\",\r\n \"contact.id\",\r\n \"contactdb.id\"\r\n ],\r\n \"headers\": [\r\n \"contact.emailaddress\",\r\n \"contact.originalid\",\r\n \"contact.id\",\r\n \"contactdb.id\"\r\n ],\r\n \"useCompression\": false,\r\n \"exportFormat\": \"CSV\",\r\n \"period\": \"ALL\",\r\n \"uploadToFtp\": false,\r\n \"ruleJson\": \"{\\\"type\\\":\\\"LOGICAL\\\",\\\"operator\\\":\\\"AND\\\",\\\"id\\\":\\\"u_48\\\",\\\"elements\\\":[{\\\"name\\\":7429,\\\"operator\\\":\\\"EQUALS\\\",\\\"values\\\":[\\\"rm\\\"],\\\"valueType\\\":\\\"0\\\",\\\"type\\\":\\\"PROPERTY\\\",\\\"property\\\":7429,\\\"id\\\":\\\"u_161\\\",\\\"valueFormat\\\":\\\"DEFAULT\\\"}]}\",\r\n \"sendEmailOnCompletion\": false,\r\n \"userToNotify\": \"jesper@symplify.com\",\r\n \"batchDescription\": \"GDPR - updated\",\r\n \"uploadToGoogleAudience\": false,\r\n \"uploadToFacebookAudience\": false,\r\n \"actions\": [\r\n \"ANONYMIZE\"\r\n ]\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/batches/exports/anonymization/schedule/{anonymizationId}","urlObject":{"path":["{{customerId}}","batches","exports","anonymization","schedule","{anonymizationId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8dd7ec2d-0c77-46a9-8e03-32c7ad1f25f3"},{"name":"Delete scheduled anonymization","id":"04f02ace-0ae9-4903-896c-9565c61be409","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/batches/exports/anonymization/schedule/{anonymizationId}","urlObject":{"path":["{{customerId}}","batches","exports","anonymization","schedule","{anonymizationId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"04f02ace-0ae9-4903-896c-9565c61be409"}],"id":"f4b0c9da-56f2-40ff-ba0e-a8d448c17871","_postman_id":"f4b0c9da-56f2-40ff-ba0e-a8d448c17871","description":""},{"name":"Webhooks","item":[{"name":"All webhooks","event":[{"listen":"test","script":{"id":"92e358be-e2db-46d2-887e-bad9fb5a9252","exec":["","",""],"type":"text/javascript"}}],"id":"8d574754-0e0f-4a10-8051-7e91cf90f284","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"file","file":{"src":""}},"url":"{{url}}/{{customerId}}/webhooks","urlObject":{"path":["{{customerId}}","webhooks"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7669d2c6-7384-4ef8-99d1-72ac93eab1de","name":"All webhooks","originalRequest":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 13:12:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"eventType\": 11,\n \"url\": \"https://1.yourendpoint.com\"\n },\n {\n \"eventType\": 5,\n \"url\": \"https://2.yourendpoint.com\"\n },\n {\n \"eventType\": 12,\n \"url\": \"https://3.yourendpoint.com\"\n },\n {\n \"eventType\": 1,\n \"url\": \"https://4.yourendpoint.com\"\n },\n {\n \"eventType\": 3,\n \"url\": \"https://5.yourendpoint.com\"\n }"}],"_postman_id":"8d574754-0e0f-4a10-8051-7e91cf90f284"},{"name":"Webhook by event type","event":[{"listen":"test","script":{"id":"92e358be-e2db-46d2-887e-bad9fb5a9252","exec":["","",""],"type":"text/javascript"}}],"id":"0af5ef6d-b81a-4065-b023-8be2693b1eba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"file","file":{"src":""}},"url":"{{url}}/{{customerId}}/webhooks/{eventType}","urlObject":{"path":["{{customerId}}","webhooks","{eventType}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"25040e4a-d220-4ee5-80d9-b80378a566e8","name":"Webhook by event type","originalRequest":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"file","file":{"src":""}},"url":"{{url}}/{{customerId}}/webhooks/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 13:16:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"eventType\": 1,\n \"url\": \"https://4.yourendpoint.com\"\n}"}],"_postman_id":"0af5ef6d-b81a-4065-b023-8be2693b1eba"},{"name":"Set webhook URL","event":[{"listen":"test","script":{"id":"92e358be-e2db-46d2-887e-bad9fb5a9252","exec":["","",""],"type":"text/javascript"}}],"id":"858061e5-1be3-4500-a3b4-5d3e48f38a67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"eventType\": 1,\n \"url\": \"http://www.example.com\"\n}"},"url":"{{url}}/{{customerId}}/webhooks","description":"\n
\n- If specific list is wanted use
\n- \"entityIds\": [\"int\"]
\n
\n\n","urlObject":{"path":["{{customerId}}","webhooks"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"858061e5-1be3-4500-a3b4-5d3e48f38a67"},{"name":"Remove webhook","event":[{"listen":"test","script":{"id":"92e358be-e2db-46d2-887e-bad9fb5a9252","exec":["",""],"type":"text/javascript"}}],"id":"2b9c3dd0-1586-4043-bb27-ddbcfe4bee36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"text/csv"}],"body":{"mode":"file","file":{"src":""}},"url":"{{url}}/{{customerId}}/webhooks/{eventTypeId}","urlObject":{"path":["{{customerId}}","webhooks","{eventTypeId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2b9c3dd0-1586-4043-bb27-ddbcfe4bee36"}],"id":"14759de9-8d11-4a75-a7f2-09caea9652f8","description":"Event type´s
\n\n
\n- 1 = Link clicked
\n- 3 = Mail opened
\n- 5 = Opt out
\n- 6 = Bounce
\n- 8 = Trigger failed
\n- 9 = Sms inbox
\n- 11 = Contact updated
\n- 12 = Opt in
\n
View and manage the your webhooks.
\n","_postman_id":"14759de9-8d11-4a75-a7f2-09caea9652f8"},{"name":"Run segment test (dry run)","item":[{"name":"Get segment JSON","event":[{"listen":"test","script":{"id":"3c3142f7-c903-4d51-b12c-1e371d39ecfb","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"dryRunId\", jsonData.id);"],"type":"text/javascript"}}],"id":"171ec59f-3903-41f4-b069-e16ffef5fdbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/{{customerId}}/filters/{filterID}","description":"Get the rule JSON to use when exporting or starting segment tests.
\n","urlObject":{"path":["{{customerId}}","filters","{filterID}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"171ec59f-3903-41f4-b069-e16ffef5fdbe"},{"name":"Start dry run batch","event":[{"listen":"test","script":{"id":"92e358be-e2db-46d2-887e-bad9fb5a9252","exec":["","// JSON response - set variable to next request","var jsonData = JSON.parse(responseBody);","pm.environment.set(\"dryRunId\", jsonData.id);",""],"type":"text/javascript"}}],"id":"2abf2a64-eb42-4f26-a5ef-663d1be18149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": -1,\r\n \"listId\": {{listId}},\r\n \"ruleJson\": \"{\\r\\n\\\"type\\\": \\\"LOGICAL\\\",\\r\\n\\\"operator\\\": \\\"AND\\\",\\r\\n\\\"id\\\": \\\"u_40\\\",\\r\\n\\\"elements\\\": [\\r\\n{\\r\\n\\\"name\\\": \\\"emailaddress\\\",\\r\\n\\\"operator\\\": \\\"NOT_EMPTY\\\",\\r\\n\\\"values\\\": [\\r\\n\\\"\\\"\\r\\n],\\r\\n\\\"valueType\\\": \\\"0\\\",\\r\\n\\\"type\\\": \\\"PROPERTY\\\",\\r\\n\\\"property\\\": \\\"emailaddress\\\",\\r\\n\\\"id\\\": \\\"u_158\\\",\\r\\n\\\"valueFormat\\\": \\\"DEFAULT\\\"\\r\\n}\\r\\n]\\r\\n}\",\r\n \"includeInactive\": true,\r\n \"filterTotal\": true,\r\n \"summaryCriteria\": [\"ALL\"]\r\n}"},"url":"{{url}}/{{customerId}}/batches/dryrun","description":"Example response:
\n201 Created
\n{\n \"id\": 3482578,\n \"type\": \"DRY_RUN\",\n \"customerId\": 509,\n \"startTime\": 1675763524770,\n \"endTime\": null,\n \"affected\": 0,\n \"processed\": 0,\n \"total\": 0,\n \"status\": \"PENDING\"\n}\n\nUse the ID returned in the response in the previous request.
\nExample response:
\n200 OK
\n","urlObject":{"path":["{{customerId}}","batches","{dryRunId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c4cbd3ae-d4a2-4015-9539-c92abdf57f73"},{"name":"Get Dry Run result","event":[{"listen":"test","script":{"id":"3c3142f7-c903-4d51-b12c-1e371d39ecfb","exec":["pm.environment.unset(\"dryRunId\");"],"type":"text/javascript"}}],"id":"a058b02d-fbb1-4a31-b6eb-871d59f8ec07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/{{customerId}}/batches/{dryRunId}/result","description":"Use the ID returned in the response in the previous request.
\nExample response:
\n200 OK
\n{\n \"ALL\": {\n \"matchSummary\": {\n \"u_1124\": 1,\n \"u_1564\": 1,\n \"u_841\": 2\n },\n \"failedMatchSummary\": {\n \"u_1124\": 9,\n \"u_1564\": 8,\n \"u_841\": 8\n },\n \"matchedEndUsers\": 2,\n \"failedEndUsers\": 8\n }\n}\n\nGet segment segment result.
\n","_postman_id":"36f9bedf-d9a4-4a27-8c98-0c94ad9efba1"},{"name":"Send batch Campaign","item":[{"name":"Start batch campaign generation","event":[{"listen":"test","script":{"id":"92e358be-e2db-46d2-887e-bad9fb5a9252","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"campaignGenerationId\", jsonData.id);","",""],"type":"text/javascript"}}],"id":"1fc79e4f-cf54-4a4b-8344-7057a9bc4ab5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"CAMPAIGN\",\r\n \"id\": {campaignId},\r\n \"listId\": {{listId}},\r\n \"delimiter\": 9,\r\n \"sendTime\": \"\"\r\n}"},"url":"{{url}}/{{customerId}}/jobs/generation/fixed","description":"\n\n","urlObject":{"path":["{{customerId}}","jobs","generation","fixed"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1fc79e4f-cf54-4a4b-8344-7057a9bc4ab5"},{"name":"Specify campaign recipients","event":[{"listen":"test","script":{"id":"92e358be-e2db-46d2-887e-bad9fb5a9252","exec":["","var jsonData = JSON.parse(responseBody);","pm.environment.set(\"campaignGenerationId\", jsonData.id);","",""],"type":"text/javascript"}}],"id":"c9fe90a9-0713-4e56-b1d5-bf5e0027723c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"text/csv"}],"body":{"mode":"file","file":{"src":""}},"url":"{{url}}/{{customerId}}/jobs/generation/fixed/{campaignGenerationId}/recipients","description":"Delimiter ASCII code
\nsee theasciicode.com
\n9 = tab
\n
\n\n
Example file rows
\ntab delimited txt file
\noriginalId emailAddress firstName\noriginalid-1 aretha@example.com Aretha\noriginalid-2 p.simon@example.com Paul\n\n\n\n","urlObject":{"path":["{{customerId}}","jobs","generation","fixed","{campaignGenerationId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f1b609a-65e0-444a-9b2e-e462602f5d85"}],"id":"ba2b65aa-4aa0-4d38-b9e7-b85b494075b1","_postman_id":"ba2b65aa-4aa0-4d38-b9e7-b85b494075b1","description":""},{"name":"Properties (Contact attributes)","item":[{"name":"Properties","event":[{"listen":"test","script":{"id":"1cef130f-b56c-4804-af80-37621bc93ee4","exec":[""],"type":"text/javascript"}}],"id":"db8aafe6-3402-487b-a1e7-254a79eb02fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/{{customerId}}/properties","urlObject":{"path":["{{customerId}}","properties"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"db8aafe6-3402-487b-a1e7-254a79eb02fd"},{"name":"Create property","event":[{"listen":"test","script":{"id":"76376409-1e6e-4d3e-bb42-f92447fe088c","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"propertyId\", jsonData.id);"],"type":"text/javascript"}}],"id":"3e4f9753-d662-4493-8e3f-8d08c817a927","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"propertyTypeId\": 1,\r\n \"name\": \"ApiCreatedProperty\",\r\n \"description\": \"Created via API\",\r\n \"dataType\": \"STRING\",\r\n \"includeInBaExport\": false,\r\n \"staticProperty\": false,\r\n \"fileHeaders\": [\r\n \"ApiCreatedProperty\"\r\n ]\r\n}\r\n"},"url":"{{url}}/{{customerId}}/properties","urlObject":{"path":["{{customerId}}","properties"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e4f9753-d662-4493-8e3f-8d08c817a927"},{"name":"Update property","event":[{"listen":"test","script":{"id":"76376409-1e6e-4d3e-bb42-f92447fe088c","exec":[""],"type":"text/javascript"}}],"id":"b4d90593-1e04-4b27-bd15-7fd45e156110","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": {propertyId},\r\n \"propertyTypeId\": 1,\r\n \"name\": \"ApiCreatedProperty\",\r\n \"description\": \"Created via API - and updated\",\r\n \"dataType\": \"STRING\",\r\n \"staticProperty\": false,\r\n \"fileHeaders\": [\r\n \"ApiCreatedProperty\",\r\n \"AddAnotherFileHeader\"\r\n ]\r\n}"},"url":"{{url}}/{{customerId}}/properties/{propertyId}","urlObject":{"path":["{{customerId}}","properties","{propertyId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4d90593-1e04-4b27-bd15-7fd45e156110"},{"name":"Delete property","event":[{"listen":"test","script":{"id":"87100909-0fe8-49a9-837b-cfbc24ae6de9","exec":[""],"type":"text/javascript"}}],"id":"e319d380-4b28-4b56-b054-388ccc7b9f60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/properties/{propertyId}","urlObject":{"path":["{{customerId}}","properties","{propertyId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e319d380-4b28-4b56-b054-388ccc7b9f60"}],"id":"10b1a97e-ba2d-4ba1-bee1-cbb74fb19d34","description":"Use id from previous request´s response
\n
Your contact data is stored in properties (attributes) and values are unique for an original id and list.
\nWhen a property is updated it will overwrite the previous value.
\n\n","_postman_id":"10b1a97e-ba2d-4ba1-bee1-cbb74fb19d34"},{"name":"Snippets","item":[{"name":"All snippets","event":[{"listen":"test","script":{"id":"1cef130f-b56c-4804-af80-37621bc93ee4","exec":[""],"type":"text/javascript"}}],"id":"e01f0be8-ed1e-4aa8-a0b4-dd7c0dc01cd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/{{customerId}}/snippets","urlObject":{"path":["{{customerId}}","snippets"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e01f0be8-ed1e-4aa8-a0b4-dd7c0dc01cd1"},{"name":"Snippet by Id","event":[{"listen":"test","script":{"id":"1cef130f-b56c-4804-af80-37621bc93ee4","exec":[""],"type":"text/javascript"}}],"id":"98b7cb5a-b0e4-428c-84d9-4049328ebc01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/{{customerId}}/snippets/{snippetId}","urlObject":{"path":["{{customerId}}","snippets","{snippetId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"98b7cb5a-b0e4-428c-84d9-4049328ebc01"},{"name":"Create snippet","event":[{"listen":"test","script":{"id":"76376409-1e6e-4d3e-bb42-f92447fe088c","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"snippetId\", jsonData.id);"],"type":"text/javascript"}}],"id":"92f292d1-9c92-410c-a0ce-99b1bd7bdb76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"snippetApiCreated\",\r\n \"description\": \"Created via API\",\r\n \"code\": \"Hello {{contact.firstName}}! How are you?\"\r\n}"},"url":"{{url}}/{{customerId}}/snippets","urlObject":{"path":["{{customerId}}","snippets"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"92f292d1-9c92-410c-a0ce-99b1bd7bdb76"},{"name":"Update snippet","event":[{"listen":"test","script":{"id":"76376409-1e6e-4d3e-bb42-f92447fe088c","exec":[""],"type":"text/javascript"}}],"id":"3c38ac8d-f50b-4c1d-8b2c-70026a0e75c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": {snippetId},\n \"name\": \"snippetApiCreated\",\n \"description\": \"Created via API - and updated\",\n \"code\": \"Hello {{contact.firstName}}! How are you? Better now? Bye\"\n}"},"url":"{{url}}/{{customerId}}/snippets/{snippetId}","urlObject":{"path":["{{customerId}}","snippets","{snippetId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c38ac8d-f50b-4c1d-8b2c-70026a0e75c2"},{"name":"Delete snippet","event":[{"listen":"test","script":{"id":"87100909-0fe8-49a9-837b-cfbc24ae6de9","exec":[""],"type":"text/javascript"}}],"id":"0ca6a2e5-96e4-410f-9521-3c1d6a6b1eec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/snippets/{snippetId}","urlObject":{"path":["{{customerId}}","snippets","{snippetId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ca6a2e5-96e4-410f-9521-3c1d6a6b1eec"}],"id":"d0cf757c-edc9-41ec-9d37-f12022d84f9d","_postman_id":"d0cf757c-edc9-41ec-9d37-f12022d84f9d","description":""},{"name":"Journeys/Campaign Manager","item":[{"name":"View journeys","item":[{"name":"All Journeys","id":"9a19946a-a3f3-49d8-aab0-cc66524d371b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/journeys","description":"","urlObject":{"path":["{{customerId}}","journeys"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"439009c7-0b78-4319-b8dc-d150832dd7d5","name":"All Journeys","originalRequest":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/{{customerId}}/journeys?projectId=55000","host":["{{url}}"],"path":["{{customerId}}","journeys"],"query":[{"key":"projectId","value":"55000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 07 Feb 2024 10:20:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 384,\n \"projectId\": 55000,\n \"name\": \"Multistep campaign 123\",\n \"description\": \"\",\n \"reenterAllowed\": true,\n \"data\": {},\n \"state\": \"LIVE\",\n \"type\": \"CAMPAIGN\",\n \"permissions\": null\n },\n {\n \"id\": 463,\n \"projectId\": 55000,\n \"name\": \"Journey A\",\n \"description\": \"\",\n \"reenterAllowed\": false,\n \"data\": {},\n \"state\": \"LIVE\",\n \"type\": \"PERIODIC\",\n \"permissions\": null\n },\n {\n \"id\": 651,\n \"projectId\": 55000,\n \"name\": \"Journey B\",\n \"description\": \"\",\n \"reenterAllowed\": true,\n \"data\": {},\n \"state\": \"PAST\",\n \"type\": \"PERIODIC\",\n \"permissions\": null\n }\n]"}],"_postman_id":"9a19946a-a3f3-49d8-aab0-cc66524d371b"},{"name":"All Journeys overviews","id":"801559db-ef84-44c6-9a01-73778848249b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/journeys/overviews","urlObject":{"path":["{{customerId}}","journeys","overviews"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a3089f0a-f252-46ba-af80-f0b3c1515c3b","name":"All Journeys overviews","originalRequest":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/journeys/overviews"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 07 Feb 2024 10:22:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":" {\n \"id\": 1001,\n \"name\": \"Journey A\",\n \"projectId\": 55000,\n \"projectName\": \"Project 1\",\n \"firstActivated\": 1543937908737,\n \"firstActivatedBy\": \"Aretha\",\n \"lastActivated\": 1545135057643,\n \"lastActivatedBy\": \"Lady\",\n \"contactsEntered\": 1502675,\n \"contactsExited\": 1501432,\n \"lastModified\": 1631516962863,\n \"lastModifiedBy\": \"Lady\",\n \"permissions\": null,\n \"status\": \"LIVE\"\n },\n {\n \"id\": 1002,\n \"name\": \"Journey B\",\n \"projectId\": 55001,\n \"projectName\": \"Project 2\",\n \"firstActivated\": 1603899905677,\n \"firstActivatedBy\": \"Lady\",\n \"lastActivated\": 1603899905677,\n \"lastActivatedBy\": \"PaulS\",\n \"contactsEntered\": 903266,\n \"contactsExited\": 903266,\n \"lastModified\": 1603899905677,\n \"lastModifiedBy\": \"PaulS\",\n \"permissions\": null,\n \"status\": \"PAST\"\n },\n {\n \"id\": 1003,\n \"name\": \"Journey C\",\n \"projectId\": 55001,\n \"projectName\": \"Project 2\",\n \"firstActivated\": 1604490970227,\n \"firstActivatedBy\": \"Lady\",\n \"lastActivated\": 1614269933337,\n \"lastActivatedBy\": \"PaulS\",\n \"contactsEntered\": 108149,\n \"contactsExited\": 108048,\n \"lastModified\": 1631874804447,\n \"lastModifiedBy\": \"PaulS\",\n \"permissions\": null,\n \"status\": \"LIVE\"\n },"}],"_postman_id":"801559db-ef84-44c6-9a01-73778848249b"},{"name":"Specific Journey overview","id":"8055164f-cb5d-466d-bdb0-f527869bd3e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/journeys/{journeyId}/overview","description":"Start and end date must be specified when fetching the overview for a specific journey.
\nThis is included in the query:
\n?start=YYYY-DD-MM&end=YYYY-DD-MM
Initiate the import.
\nIf downloadUrl is specified, the file will be downloaded immediately, and the batch will start automatically.
\nOtherwise the response will include an uploadUrl, to which the file must be uploaded. The uploadUrl is valid for 12 hours.
\nThe data file is expected to be an UTF8-encoded text file where each line is in a JSON object (see introduction)
\nAny contacts not already present in the system will be automatically created; already existing contacts will be 'touched'.
\n","urlObject":{"path":["{{customerId}}","batchtrigger","v2"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"664821cc-f9b6-4f63-a75e-68c602f1a655","name":"No downloadUrl","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"JOURNEY_COMMENCE\",\r\n \"entityId\": 17599,\r\n \"saveProps\": true,\r\n \"contentType\": \"text/plain\",\r\n \"customData\": {\r\n \"empty\": false\r\n },\r\n \"downloadUrl\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/batchtrigger/v2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 09:26:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"uploadUrl\": \"https://symplify-batchtrigger-test.cellar-c2.services.clever-cloud.com/uploads/www4/2132132714244187616a2fd9b971428a36cf0ffbf406614aba8b52ea751120240cdaf0d2f582?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230215T092613Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=43200&X-Amz-Credential=7592P7HGPDWAYHHO8W7Q%2F20230215%2request&X-Amz-Signature=5db617bf8ab078f7fa21ada7f9ab7aa1acc9f360f7\",\n \"status\": \"WAITING_FOR_UPLOAD\",\n \"batchProgressUri\": \"/rest/3000/batches/future/oTrTq8II2VcyKUoqd9SRdYZGClmSTi2I\",\n \"batchProgressToken\": \"oTrTq8II2VcyKUoqd9SRdYZGClmSTi2I\"\n}"},{"id":"4cf53d25-dec8-43c2-b8bb-2bd59babec6c","name":"With downloadUrl","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"JOURNEY_COMMENCE\",\r\n \"entityId\": 17599,\r\n \"saveProps\": true,\r\n \"contentType\": \"text/plain\",\r\n \"customData\": {\r\n \"empty\": false\r\n },\r\n \"downloadUrl\": \"http://yourfilestorage.com/folder/file_for_upload.txt\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/batchtrigger/v2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 09:34:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"uploadUrl\": null,\n \"status\": \"PENDING\",\n \"batchProgressUri\": \"/rest/3000/batches/future/FpdHLEhl98uLHFfRBCK1VpMPUGWbaN6z\",\n \"batchProgressToken\": \"FpdHLEhl98uLHFfRBCK1VpMPUGWbaN6z\"\n}"},{"id":"b8363278-a699-48d5-ad24-bf427f841f01","name":"409 - Already triggered (CM)","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"JOURNEY_COMMENCE\",\r\n \"entityId\": 17611,\r\n \"saveProps\": true,\r\n \"contentType\": \"text/plain\",\r\n \"customData\": {\r\n \"empty\": false\r\n },\r\n \"downloadUrl\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/batchtrigger/v2"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 09:55:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Journey cannot be triggered - status is ALREADY_TRIGGERED\"\n}"},{"id":"cf4b11bb-ebdf-4e1b-907d-aab57c3ee399","name":"409 - No active version (CM)","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"JOURNEY_COMMENCE\",\r\n \"entityId\": 17621,\r\n \"saveProps\": true,\r\n \"contentType\": \"text/plain\",\r\n \"customData\": {\r\n \"empty\": false\r\n },\r\n \"downloadUrl\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/batchtrigger/v2"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 09:56:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Journey cannot be triggered - status is NO_ACTIVE_VERSION\"\n}"}],"_postman_id":"64e975ff-f0df-48c4-9428-370ef93162d1"},{"name":"Upload file","id":"30030196-b8d0-448a-ab05-c6c4e9179fe0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"text/plain","type":"text"}],"body":{"mode":"file","file":{"src":"/Users/oida/Downloads/json_file.txt"}},"url":"{uploadUrl}","description":"You may now upload the contact file using a PUT to the uploadUrl specified in the previous response.
\nThe batch will start within seconds after the file has been uploaded.
\nPlease note:
\n- \n
- The value of Content-Type header should be text/plain \n
- The uploaded file should be UTF-8 encoded. \n
- The uploadUrl is valid for 12 hours. \n
- The file must be publically available for download. For this reason, it is recommended that it's protected using a secure, time-based signature. \n
The response when initiating an import will include batchProgressUri (endpoint and batchProgressToken) and batchProgressToken, which can be used to check the status of an import.
The respons will include any of the statuses:
\n- \n
- PENDING (about to start) \n
- IN_PROGRESS (importing) \n
- FINISHED (Import completed) \n
- ERROR (Import failed) \n
This guide is about triggering multiple contacts to a journey or a campaign in Campaign Manager.
\nSay that you have a large number of contacts gathered in some other system that you want to trigger a journey or a campaign for at the same time. To accomplish this you should use the batchtrigger endpoint of the Symplify REST API.
\nNote for Journeys: this endpoint is only intended for when you have a number of contacts that should be entered at the same time; this endpoint is not intended for use when entering individual contacts to a Journey. For that purpose, please use the single request.
\nPrerequisites
\nThe API batch starter requires an input file with JSON rows representing each individual contact to be added to the journey/campaign:
\n{\"id\": \"0\", \"properties\": {\"emailAddress\": \"the_boss@example.com\", \"firstname\": \"Bruce\", \"attributeName\": \"yes\"}}\n{\"id\": \"1\", \"properties\": {\"emailAddress\": \"aretha.f@example.com\", \"firstname\": \"Aretha\", \"attributeName\": \"yes\"}}\n{\"id\": \"2\", \"properties\": {\"emailAddress\": \"ladygaga@example.com\", \"firstname\": \"Lady\", \"attributeName\": \"no\"}}\n\nNOTE: Each row in the input file needs to be a separate JSON object. Do NOT use a JSON array.
\nThe \"id\" attribute of each JSON object in the file represents the original id of the contact. The \"properties\" attribute can be used to supply additional data with each contact for use, e.g. in segments or placeholders.
\nThe contact file can be supplied to Symplify in two different ways: Symplify can download the file from a specified URI, or it can be accepted as a PUT to a pre-signed URI received from the Symplify API.
\nYou will initiate using a POST and the request payload will be different depending on which approach you use.
\nYou can include data and use \"saveProps\": false. By doing so, included default attributes, such as email address and date of birth, will get updated but not custom attributes.
The custom attributes, will not overwrite the data on the contact but can be used for content rendering (content segment and placeholders) throughout the journey. However, the temporary journey data can not be used in segment splits.
\nInclude the same contact multiple times
\nBy default, a contact that is found multiple times in a file, will only enter the journey one time (and any other rows will fail).
However, it is possible to enter a specific contact multiple times with the same file.
This means that if original id 2 is found two times in a file, the contact will enter the journey two times (on different trips) and run throughout the journey on separate trips.
{\"id\": \"0\", \"properties\": {\"emailAddress\": \"the_boss@example.com\", \"firstname\": \"Bruce\", \"attributeName\": \"yes\"}}\n{\"id\": \"1\", \"properties\": {\"emailAddress\": \"aretha.f@example.com\", \"firstname\": \"Aretha\", \"attributeName\": \"yes\"}}\n{\"id\": \"2\", \"properties\": {\"emailAddress\": \"ladygaga@example.com\", \"firstname\": \"Lady\", \"attributeName\": \"no\"}}\n{\"id\": \"2\", \"properties\": {\"emailAddress\": \"ladygaga@example.com\", \"firstname\": \"Lady\", \"attributeName\": \"yes\"}}\n\nThe functionality needs activation on your account so please reach out to your Success manager if you want to learn more and activate. This will affect all your journeys (using multiple API starter).
\nInclude DataDocs
\nIf you want to refer to one or more specific document(s) in your journey you need to define these when triggering the contacts.
\n{\"id\": \"1\",\"properties\": {\"level\": \"silver\"},\"dataDocs\": [{\"documentTypeId\": 38,\"externalId\": \"2023-2\"}, {\"documentTypeId\": 39,\"externalId\": \"A-2023-1\"}]}\n{\"id\": \"2\",\"properties\": {\"level\": \"silver\"},\"dataDocs\": [{\"documentTypeId\": 38,\"externalId\": \"2023-3-1\"}]}\n\nThe targeted documents will be included in all your steps and can be used in placeholders for rendering content or segment splits.
\n","_postman_id":"6dbe5ceb-1cbb-4db7-8aa6-404ff4b271d3"},{"name":"Start journey (single contact)","id":"70163ac9-64d4-4d09-ab76-2bf4141a9589","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"originalId\": \"originalId\",\r\n \"properties\": {\r\n \t\"emailAddress\": \"john@example.com\",\r\n \t\"firstName\": \"John\",\r\n \t\"lastName\": \"Doe\",\r\n \t\"mobileNumber\": \"123456789\"\r\n },\r\n \"saveProps\": false\r\n}"},"url":"{{url}}/{{customerId}}/journeys/{journeyId}/commence","description":"The journey commence triggers one journey for one single contact.
\nYou can include data and use \"saveProps\": false. By doing so, included default attributes, such as email address and date of birth, will get updated but not custom attributes.
The custom attributes, will not overwrite the data on the contact but can be used for content rendering (content segment and placeholders) throughout the journey. However, the temporary journey data can not be used in segment splits.
\nRefer to DataDocs
\nIf you want to trigger a journey and refer to one or more specific documents you include the document type and the externalId in the body (see example \"Including DataDocs):
\n \"dataDocs\":\n [{\n \"documentTypeId\": {documentTypeId},\n \"externalId\": \"{externalId}\"\n }]\n\nThe targeted documents will be included in all your steps and can be used in placeholders for rendering content or segment splits.
\n","urlObject":{"path":["{{customerId}}","journeys","{journeyId}","commence"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1c2209a2-3b2f-4663-bf98-f728c255711c","name":"200","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"originalId\": \"1\",\r\n \"properties\": {\r\n \t\"emailAddress\": \"john@example.com\",\r\n \t\"firstName\": \"John\",\r\n \t\"lastName\": \"Doe\",\r\n \t\"mobileNumber\": \"123456789\"\r\n },\r\n \"saveProps\": false\r\n}"},"url":"{{url}}/{{customerId}}/journeys/{journeyId}/commence"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 09:21:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null},{"id":"93252381-1788-46f6-a660-ec0c3f07bf29","name":"Including DataDocs","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"originalId\": \"404401\",\r\n \"dataDocs\":\r\n [{\r\n \"documentTypeId\": 38,\r\n \"externalId\": \"2023-2\"\r\n }],\r\n \r\n \"properties\": \r\n {\r\n \"level\": \"silver\"\r\n },\r\n \"saveProps\": false\r\n }"},"url":"{{url}}/{{customerId}}/journeys/1825/commence"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 11 May 2023 12:40:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null},{"id":"819313e9-d9cb-465a-a2fd-38123fb10a2f","name":"404 - No active journey version","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"originalId\": \"1\",\r\n \"properties\": {\r\n \t\"emailAddress\": \"john@example.com\",\r\n \t\"firstName\": \"John\",\r\n \t\"lastName\": \"Doe\",\r\n \t\"mobileNumber\": \"123456789\"\r\n },\r\n \"saveProps\": false\r\n}"},"url":"{{url}}/{{customerId}}/journeys/{journeyId}/commence"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 09:19:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Incorrect result size: expected 1, actual 0\"\n}"}],"_postman_id":"70163ac9-64d4-4d09-ab76-2bf4141a9589"},{"name":"Start journey (single contact) with PDF attachment","id":"751fed93-12ec-47db-be03-55b9f3104b51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"originalId\": \"originalId\",\r\n \"attachmentUrl\": \"https://stcustomerdspcommunidev.blob.core.windows.net/invoice-pdf/2023/order_1234_invoice_5678.pdf?sp=r&st=2023-06-13T08:32:11Z&se=2024-06-13T16:32:11Z&spr=https&sv=2022-11-02&sr=b&sig=kmEmRodA977MUaLnr2N2%2FS3FtPPde0aSEqv3ZcWIeas%3D\",\r\n \"properties\": {\r\n \"emailAddress\": \"john@example.com\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"mobileNumber\": \"123456789\"\r\n },\r\n \"saveProps\": false\r\n}"},"url":"{{url}}/{{customerId}}/journeys/{journeyId}/commence","description":"When triggering a transactional email in a journey for a single contact you can include a PDF attachment.
\nYou store the files on your end and make sure that they are reachable for the service.
\nIt is our strongest recommendation to use presigned URL's to the files to ensure maximum security.
\nEnsure that the sendout step in your journey is allowing PDF attachments.
\nPlease note that this is an add-on feature. Reach out to your Success manager at Symplify to learn more.
\n","urlObject":{"path":["{{customerId}}","journeys","{journeyId}","commence"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a4a2680e-d829-445d-8748-86406d9e7b56","name":"200","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"originalId\": \"1\",\r\n \"properties\": {\r\n \t\"emailAddress\": \"john@example.com\",\r\n \t\"firstName\": \"John\",\r\n \t\"lastName\": \"Doe\",\r\n \t\"mobileNumber\": \"123456789\"\r\n },\r\n \"saveProps\": false\r\n}"},"url":"{{url}}/{{customerId}}/journeys/{journeyId}/commence"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 09:21:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null},{"id":"e29adb43-45fa-4e33-a768-bfc2eb4db6cd","name":"Including DataDocs","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"originalId\": \"404401\",\r\n \"dataDocs\":\r\n [{\r\n \"documentTypeId\": 38,\r\n \"externalId\": \"2023-2\"\r\n }],\r\n \r\n \"properties\": \r\n {\r\n \"level\": \"silver\"\r\n },\r\n \"saveProps\": false\r\n }"},"url":"{{url}}/{{customerId}}/journeys/1825/commence"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 11 May 2023 12:40:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null},{"id":"a05f24f6-777f-4178-afb8-229e163ab4ed","name":"404 - No active journey version","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"originalId\": \"1\",\r\n \"properties\": {\r\n \t\"emailAddress\": \"john@example.com\",\r\n \t\"firstName\": \"John\",\r\n \t\"lastName\": \"Doe\",\r\n \t\"mobileNumber\": \"123456789\"\r\n },\r\n \"saveProps\": false\r\n}"},"url":"{{url}}/{{customerId}}/journeys/{journeyId}/commence"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Feb 2023 09:19:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Incorrect result size: expected 1, actual 0\"\n}"}],"_postman_id":"751fed93-12ec-47db-be03-55b9f3104b51"}],"id":"5320b106-29df-42ff-a674-cb953c3c7b36","_postman_id":"5320b106-29df-42ff-a674-cb953c3c7b36","description":""},{"name":"Purchase History","item":[{"name":"GET & SET columns","item":[{"name":"Get PH column mapping","event":[{"listen":"test","script":{"id":"1ef22377-25de-41cc-8580-a5a9f437589f","exec":[""],"type":"text/javascript"}}],"id":"9c1f290a-f53d-48cb-9e84-8ee30fb072af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/{{customerId}}/purchasehistory/columns","urlObject":{"path":["{{customerId}}","purchasehistory","columns"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"dbb70638-20d3-4bd9-b9de-86a5b04405ec","name":"Get PH column mapping","originalRequest":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/{{customerId}}/purchasehistory/columns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 10 Feb 2023 14:31:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"column1\": \"product\",\n \"column2\": \"startdate\",\n \"column3\": \"enddate\",\n \"column4\": \"C4\",\n \"column5\": \"C5\",\n \"column6\": \"C6\",\n \"column7\": \"C7\",\n \"column8\": \"C8\",\n \"column9\": null,\n \"column10\": \"null\",\n \"column11\": \"null\",\n \"column12\": \"null\",\n \"column13\": \"null\",\n \"column14\": \"null\",\n \"column15\": \"null\",\n \"column16\": null,\n \"column17\": null,\n \"column18\": null,\n \"column19\": null,\n \"column20\": null,\n \"column21\": null,\n \"column22\": null,\n \"column23\": null,\n \"column24\": null,\n \"column25\": null,\n \"column26\": null\n}"}],"_postman_id":"9c1f290a-f53d-48cb-9e84-8ee30fb072af"},{"name":"Set PH column mapping","event":[{"listen":"test","script":{"id":"1ef22377-25de-41cc-8580-a5a9f437589f","exec":[""],"type":"text/javascript"}}],"id":"f431400a-f325-4128-8976-9a1de339041e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"column1\": \"sku\",\r\n \"column2\": \"Category1\",\r\n \"column3\": \"Category2\",\r\n \"column4\": \"Color\",\r\n \"column5\": \"Size\",\r\n \"column6\": \"column 6\",\r\n \"column7\": \"\",\r\n \"column8\": \"\",\r\n \"column9\": \"\",\r\n \"column10\": \"\",\r\n \"column11\": \"\",\r\n \"column12\": \"\",\r\n \"column13\": \"\",\r\n \"column14\": \"\",\r\n \"column15\": \"\",\r\n \"column16\": \"\",\r\n \"column17\": \"\",\r\n \"column18\": \"\",\r\n \"column19\": \"\",\r\n \"column20\": \"\",\r\n \"column21\": \"\",\r\n \"column22\": \"\",\r\n \"column23\": \"\",\r\n \"column24\": \"\",\r\n \"column25\": \"\",\r\n \"column26\": \"\"\r\n}"},"url":"{{url}}/{{customerId}}/purchasehistory/columns","urlObject":{"path":["{{customerId}}","purchasehistory","columns"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"13cae020-b4f4-47c4-ad4f-06d857a81bf1","name":"Set PH column mapping","originalRequest":{"method":"PUT","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"column1\": \"\",\r\n \"column2\": \"\",\r\n \"column3\": \"\",\r\n \"column4\": \"\",\r\n \"column5\": \"\",\r\n \"column6\": \"\",\r\n \"column7\": \"\",\r\n \"column8\": \"Color\",\r\n \"column9\": \"Size\",\r\n \"column10\": \"\",\r\n \"column11\": \"\",\r\n \"column12\": \"\",\r\n \"column13\": \"\",\r\n \"column14\": \"\",\r\n \"column15\": \"\",\r\n \"column16\": \"\",\r\n \"column17\": \"\",\r\n \"column18\": \"\",\r\n \"column19\": \"\",\r\n \"column20\": \"\",\r\n \"column21\": \"\",\r\n \"column22\": \"\",\r\n \"column23\": \"\",\r\n \"column24\": \"\",\r\n \"column25\": \"\",\r\n \"column26\": \"\"\r\n}"},"url":"{{url}}/{{customerId}}/purchasehistory/columns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 10 Feb 2023 14:40:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f431400a-f325-4128-8976-9a1de339041e"}],"id":"9ce90a0b-6894-4a2d-ae89-60b796288b12","description":"\n\n","_postman_id":"9ce90a0b-6894-4a2d-ae89-60b796288b12"},{"name":"PH import","item":[{"name":"PH import JSON rows","event":[{"listen":"test","script":{"id":"68d56f2f-20c3-4ead-af80-a897cd23b456","exec":[""],"type":"text/javascript"}}],"id":"9675d5c5-cc54-4871-9ee2-a3242e74929f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"rows\": [\r\n {\r\n \t\"originalId\": \"abc1\",\r\n \"column1\": \"sku-1\",\r\n \"itemPrice\": \"100.00\",\r\n \"transactionDate\": \"2023-01-01T01:00:00\",\r\n \"count\": \"1\",\r\n \"totalPrice\": \"100.00\",\r\n \"column2\": \"category1\",\r\n \"column3\": \"category2\",\r\n \"column4\": \"color\",\r\n \"column5\": \"size\",\r\n \"column6\": \"hello world\"\r\n },\r\n {\r\n \t\"originalId\": \"abc1\",\r\n \"column1\": \"sku-2\",\r\n \"itemPrice\": \"200.00\",\r\n \"transactionDate\": \"2023-01-01T02:00:00\",\r\n \"count\": \"2\",\r\n \"totalPrice\": \"400.00\",\r\n \"column2\": \"category1\",\r\n \"column3\": \"category2\",\r\n \"column4\": \"color\",\r\n \"column5\": \"size\",\r\n \"column6\": \"hello world\"\r\n },\r\n {\r\n \t\"originalId\": \"abc2\",\r\n \"column1\": \"sku-3\",\r\n \"itemPrice\": \"300.00\",\r\n \"transactionDate\": \"2023-01-01T03:00:00\",\r\n \"count\": \"3\",\r\n \"totalPrice\": \"900.00\",\r\n \"column2\": \"category1\",\r\n \"column3\": \"category2\",\r\n \"column4\": \"color\",\r\n \"column5\": \"size\",\r\n \"column6\": \"hello world\"\r\n }\r\n]\r\n}"},"url":"{{url}}/{{customerId}}/purchasehistory/rows","urlObject":{"path":["{{customerId}}","purchasehistory","rows"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9675d5c5-cc54-4871-9ee2-a3242e74929f"},{"name":"PH import file - start job","event":[{"listen":"test","script":{"id":"68d56f2f-20c3-4ead-af80-a897cd23b456","exec":[""],"type":"text/javascript"}}],"id":"c890a28b-c405-4839-9b82-19f0608c8f5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"file","file":{"src":""}},"url":"{{url}}/{{customerId}}/purchasehistory/imports","description":"**Please note that Purchase history is depracated. No new integrations will include this integration option.**The following documentation is only to support already existing integrations.
\n
Reach out to your success manager if you have any questions.
\n\nPlease note that Purchase history is depracated. No new integrations will include this integration option.
\n
The following documentation is only to support already existing integrations.
\n\n
Example file rows
\n{\n \"rows\": [\n {\n \"originalId\": \"originalid-1\",\n \"column1\": \"sku-1\",\n \"itemPrice\": \"100.00\",\n \"transactionDate\": \"2001-01-01T01:00:00\",\n \"count\": \"1\",\n \"totalPrice\": \"100.00\",\n \"column2\": \"category1\",\n \"column3\": \"category2\",\n \"column4\": \"color\",\n \"column5\": \"size\",\n \"column6\": \"hello world\"\n }\n]\n}\n\n\n\nPlease note that Purchase history is depracated. No new integrations will include this integration option.
\n
The following documentation is only to support already existing integrations.
\n\n
Example file rows
\n{\n \"rows\": [\n {\n \"originalId\": \"originalid-1\",\n \"column1\": \"sku-1\",\n \"itemPrice\": \"100.00\",\n \"transactionDate\": \"2001-01-01T01:00:00\",\n \"count\": \"1\",\n \"totalPrice\": \"100.00\",\n \"column2\": \"category1\",\n \"column3\": \"category2\",\n \"column4\": \"color\",\n \"column5\": \"size\",\n \"column6\": \"hello world\"\n }\n]\n}\n\n\n\nPlease note that Purchase history is depracated. No new integrations will include this integration option.
\n
The following documentation is only to support already existing integrations.
Check batch status
\nWhen the file has successfully been uploaded you can query the API to trace the imports progress. Use the batchId from the previous request. You can keep polling the method until you receive a response with the status set to “FINISHED”. Do not poll too often as that will put unnecessary strain on the system. Polling once every 30 seconds or every minute is normally sufficient.
\nStatus will go from PENDING to IN_PROGRESS to FINISHED.
\n","urlObject":{"path":["{{customerId}}","batches","{batchId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9fccab87-4d8c-4e2f-9dd6-516b53221b19","name":"Get Batch info","originalRequest":{"method":"GET","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/{{customerId}}/batches/3500517"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 22 Feb 2023 09:25:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3500517,\n \"type\": \"IMPORT\",\n \"customerId\": 509,\n \"startTime\": 1677057932880,\n \"endTime\": 1677057933167,\n \"affected\": 2,\n \"processed\": 2,\n \"total\": 2,\n \"status\": \"FINISHED\"\n}"}],"_postman_id":"0bc93d98-e306-4482-8f37-f275e3930717"}],"id":"f9ccfdd7-c8d1-48b6-ad00-7c6e01183ea6","description":"\n\nPlease note that Purchase history is depracated. No new integrations will include this integration option.
\n
The following documentation is only to support already existing integrations.
Reach out to your success manager if you have any questions.
\nBefore you start, please be aware that batch imports triggered by the API adds an overhead to each included file. You should therefor send larger files less often, rather than smaller files frequently.
Recommended minimum import interval is hourly but a new import should not be initiated until a previous import is done (check the batch status).
If import files are triggered too frequently, the service will respond with a HTTP 429. Your import may also be throttled and placed in queue. In other words, several sequentially imported files will cause an import delay.
\nPlease observe these recommendations to avoid issues.
\n","_postman_id":"f9ccfdd7-c8d1-48b6-ad00-7c6e01183ea6"},{"name":"Get PH for contact by originalId","item":[{"name":"Get PH for contact by originalId","event":[{"listen":"test","script":{"id":"b1b249e7-47d7-4a10-a947-f51ff052d52f","exec":[""],"type":"text/javascript"}}],"id":"378244d8-1315-4355-a275-8934c2879f29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/{{customerId}}/lists/{{listId}}/contacts/{originalId}/purchasehistory","urlObject":{"path":["{{customerId}}","lists","{{listId}}","contacts","{originalId}","purchasehistory"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"378244d8-1315-4355-a275-8934c2879f29"}],"id":"6cf0003f-1e44-4509-a7f9-f34d005cee64","description":"\n\n","_postman_id":"6cf0003f-1e44-4509-a7f9-f34d005cee64"}],"id":"cb534120-a347-4542-8652-f61f183dccff","description":"Please note that Purchase history is depracated. No new integrations will include this integration option.
\n
The following documentation is only to support already existing integrations.
Please note that Purchase history is depracated. No new integrations will include this integration option.
\nThe following documentation is only to support already existing integrations.
\nReach out to your success manager if you have any questions.
\n","_postman_id":"cb534120-a347-4542-8652-f61f183dccff"},{"name":"Event hub","item":[{"name":"GENERIC_USER","id":"51041f5c-1ccb-4be6-acf5-71a63f0b1710","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"GENERIC_USER\",\r\n \"mappingSelector\": \"{mappingName}\",\r\n \"contactId\": \"{originalId}\",\r\n \"properties\": {\r\n \"attributeName1\": \"value1\",\r\n \"attributeName2\": \"value2\"\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/events","description":"The GENERIC_USER type is mostly used for:
\n- \n
- creating a contact \n
- updating a contact \n
- entering journeys \n
But you can also set default attribute values and anonymize a contact with this type.
\n","urlObject":{"path":["{{customerId}}","events"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"56b271fe-7596-409f-b1c4-aeacdcb188a5","name":"GENERIC_USER","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"GENERIC_USER\",\r\n \"mappingSelector\": \"newContact\",\r\n \"contactId\": \"123456\",\r\n \"properties\": {\r\n \"firstName\": \"Lady Gaga\",\r\n \"emailaddress\": \"lady.g@example.com\"\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/events"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 31 Aug 2023 11:58:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"51041f5c-1ccb-4be6-acf5-71a63f0b1710"},{"name":"GENERIC_USER with PDF attachment","id":"3c2007ea-37c0-4d65-ac9b-a8959b21d9ae","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"GENERIC_USER_WITH_ATTACHMENT\",\r\n \"mappingSelector\": \"{mappingName}\",\r\n \"contactId\": \"{originalId}\",\r\n \"attachmentUrl\": \"{https://yourstorage.com/location}\",\r\n \"properties\": {\r\n \"attributeName1\": \"value1\",\r\n \"attributeName2\": \"value2\"\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/events","description":"When triggering a transactional email in a journey for a single contact you can include a PDF attachment.
\nYou store the files on your end and make sure that they are reachable for the service.
\nIt is our strongest recommendation to use presigned URL's to the files to ensure maximum security.
\nEnsure that the sendout step in your journey is allowing PDF attachments.
\nPlease note that this is an add-on feature. Reach out to your Success manager at Symplify to learn more.
\n","urlObject":{"path":["{{customerId}}","events"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"85a0ae3e-05a0-43d0-a20e-c3b3b9316f15","name":"GENERIC_USER with PDF attachment","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"type\":\"GENERIC_USER_WITH_ATTACHMENT\",\r\n \"mappingSelector\": \"orderConfirmation\",\r\n \"attachmentUrl\": \"https://stcustomerdspcommunidev.blob.core.windows.net/invoice-pdf/2023/order_1234_invoice_5678.pdf?sp=r&st=2023-06-13T08:32:11Z&se=2024-06-13T16:32:11Z&spr=https&sv=2022-11-02&sr=b&sig=kmEmRodA977MUaLnr2N2%2FS3FtPPde0aSEqv3ZcWIeas%3D\",\r\n \"contactId\": \"123456\",\r\n \"properties\": {\r\n \"level\": \"123\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/{{customerId}}/events"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Tue, 15 Aug 2023 08:41:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3c2007ea-37c0-4d65-ac9b-a8959b21d9ae"},{"name":"GENERIC_USER with DataDocs","id":"5d964d62-13f7-49fd-ab78-d879be8fb808","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"GENERIC_USER_WITH_DATADOCS\",\r\n \"mappingSelector\":\"{mappingName}\",\r\n \"contactId\": \"{originalId}\",\r\n \"dataDocs\": [{ \"documentTypeId\": {typeId},\r\n \"document\": {\r\n \"externalIdAttribute\":\"value1\",\r\n \"originalIdAttribute\":\"value2\",\r\n \"json_object\": {\r\n \"header1\": \"value1\",\r\n \"header2\": \"value2\"\r\n }\r\n }\r\n }],\r\n \"properties\": {\r\n \"attributeName1\": \"value1\",\r\n \"attributeName2\": \"value2\"\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/events","description":"To add DataDocs rows via Event Hub you use the GENERIC_USER type with the addition \"_WITH_DATADOCS\".
\nNote that this event not only add DataDoc rows but also can update contact attributes data, which is why you must include your original id on both contactId and for each DataDoc row.
\nBoth externalId and originalId must be typed as a string.
This event can be mapped to the type User in the Symplify interface including any of the actions Create contact, Update contact or Upsert contact.
\nPlease note that DataDocs is an add-on feature. Reach out to your Success manager at Symplify to learn more.
\n","urlObject":{"path":["{{customerId}}","events"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9122cce6-4bc7-4409-bea7-d5f8f9dffd1a","name":"GENERIC_USER with DataDocs","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"GENERIC_USER_WITH_DATADOCS\",\r\n \"mappingSelector\":\"datadocs\",\r\n \"contactId\": \"404401\",\r\n \"dataDocs\": [{ \"documentTypeId\": 38,\r\n \"document\": {\r\n \"transaction_date\": \"2023-05-30\",\r\n \"event_date\": \"2023-07-22\",\r\n \"bookingnumber\": \"ABC-123123\",\r\n \"event_details\": {\r\n \"location\": \"Big Arena\",\r\n \"Entrance\": \"F\",\r\n \"startTime\": \"20.00\"\r\n },\r\n \"originalid\": \"404401\",\r\n \"category\": \"music\"\r\n }\r\n }],\r\n \"properties\": {\r\n\r\n \"level\": \"123\"\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/events"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Tue, 15 Aug 2023 10:45:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5d964d62-13f7-49fd-ab78-d879be8fb808"},{"name":"GENERIC_USER start journey with DataDocs","id":"119c8867-9db2-4719-a420-9086e2db419e","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"GENERIC_USER_WITH_DATADOCS\",\r\n \"mappingSelector\": \"{mappingSelector}\",\r\n \"contactId\": \"{originalId}\",\r\n \"properties\": {\r\n\r\n },\r\n \"journeyDataDocs\": [{\r\n \"documentTypeId\": {documentTypeId},\r\n \"externalId\": \"{externalId}\"\r\n },\r\n {\r\n \"documentTypeId\": {documentTypeId},\r\n \"externalId\": \"{externalId}\"\r\n }\r\n ]\r\n}\r\n\r\n"},"url":"{{url}}/{{customerId}}/events","description":"You can trigger a journey for a single contact and refer to one or more documents on that contact.
\nThe referred document(s) can be used as placeholder data in sendouts within the journey.
\nReferring is done in \"journeyDataDocs\".
\nYou can also create a document and refer to it with the same payload (see example \"Creating and referring to doc\").
\n","urlObject":{"path":["{{customerId}}","events"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"60586396-78f3-4d98-9a04-ad8b105c8524","name":"Referring to docs","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"GENERIC_USER_WITH_DATADOCS\",\r\n \"mappingSelector\": \"journey\",\r\n \"contactId\": \"111\",\r\n \"properties\": {\r\n\r\n },\r\n \"journeyDataDocs\": [{\r\n \"documentTypeId\": 1,\r\n \"externalId\": \"2023-1-111\"\r\n },\r\n {\r\n \"documentTypeId\": 1,\r\n \"externalId\": \"2023-2-111\"\r\n }\r\n ]\r\n}\r\n\r\n"},"url":"{{url}}/{{customerId}}/events"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 01 Aug 2024 13:07:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null},{"id":"30c7db94-2202-4a8f-92db-5d6b1a0f6884","name":"Creating and referring to doc","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"GENERIC_USER_WITH_DATADOCS\",\r\n \"mappingSelector\": \"journey\",\r\n \"contactId\": \"111\",\r\n \"properties\": {\r\n\r\n },\r\n \"dataDocs\": [{ \"documentTypeId\": 1,\r\n \"document\": {\r\n \"transaction_date\": \"2024-05-30\",\r\n \"event_date\": \"2024-07-22\",\r\n \"bookingnumber\": \"ABC-123123\",\r\n \"event\": \"Teletubbies in concert\",\r\n \"event_details\": {\r\n \"location\": \"Big Arena\",\r\n \"Entrance\": \"F\",\r\n \"startTime\": \"20.00\"\r\n },\r\n \"originalid\": \"111\",\r\n \"category\": \"music\"\r\n }\r\n }],\r\n\r\n \"journeyDataDocs\": [{\r\n \"documentTypeId\": 1,\r\n \"externalId\": \"ABC-123123\"\r\n }\r\n ]\r\n}\r\n\r\n"},"url":"{{url}}/{{customerId}}/events"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 01 Aug 2024 13:04:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"119c8867-9db2-4719-a420-9086e2db419e"},{"name":"GENERIC_TRANSACTION_V2 with Purchase History","id":"2673a619-dceb-4996-9bb5-ad76fd944ab4","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"GENERIC_TRANSACTION_V2\",\r\n \"mappingSelector\": \"{mappingName}\", \r\n \"contactId\": \"{originalId}\",\r\n \"timestamp\": \"{yyyy-MM-ddTHH:mm:ss}\",\r\n \"amount\": {amount.decimal},\r\n \"properties\": {\r\n \"attributeName1\": \"value1\",\r\n \"attributeName2\": \"value2\"\r\n },\r\n \"transactionAttributes\":{ \r\n \"purchaseHistoryField1\": \"value1\",\r\n \"purchaseHistoryField2\": \"value2\" \r\n }\r\n\r\n}"},"url":"{{url}}/{{customerId}}/events","description":"\n\nPlease note that Purchase history is depracated. No new integrations will include this integration option.
\n
The following documentation is only to support already existing integrations.
This event is able to both update contact attributes but also create a Purchase history row.
\nThis event should be mapped to the type Transaction in the Symplify interface including the action Create Purchase History row. Note that if you also wants to update contact attributes you will need to add corresponding action for that as well.
\nUSER_CONSENT UPDATE will toggle the default subscription statuses for email and SMS.
\nThis event can be mapped to the type Consent in the Symplify interface including actions like Create contact, Update contact or Upsert contact.
\n","urlObject":{"path":["{{customerId}}","events"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6146d41f-d3ff-4d54-946a-5caa4fe2e8ee","name":"USER_CONSENT_UPDATE","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"USER_CONSENT_UPDATE\",\r\n \"mappingSelector\": \"consent\",\r\n \"contactId\": \"8a6c62bc-6664-447d-2c48-16568030d1d1\",\r\n \"channel\": \"SMS\",\r\n \"consented\": false\r\n}"},"url":"{{url}}/{{customerId}}/events/TheQueue"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 31 Aug 2023 13:05:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c2fddb83-1274-41e0-b868-b2753c87a818"},{"name":"USER_BLOCKED with end date","id":"d20e2282-2486-45a1-9f86-6b487cd3d07c","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"USER_BLOCKED\",\r\n \"mappingSelector\": \"{mappingName}\", \r\n \"contactId\": \"{originalId}\",\r\n \"blockedUntil\":\"{yyyy-MM-ddTHH:mm:ss}\",\r\n \"properties\": {\r\n \"attributeName1\": \"value1\",\r\n \"attributeName2\": \"value2\"\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/events","description":"A USER_BLOCKED event will add a temporary block end date to a contact, meaning no messages (in any channel) will be created and sent until that date.
\nTo release a block, simply send a date in the past.
\nThis event can be mapped to the type Block in the Symplify interface including actions like Create contact, Update contact or Upsert contact.
\n","urlObject":{"path":["{{customerId}}","events"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4dd16c52-00c6-4e8b-839e-24b63133db99","name":"USER_BLOCKED with end date","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"USER_BLOCKED\",\r\n \"mappingSelector\": \"block_until\", \r\n \"contactId\": \"8a6c62bc-6664-447d-2c48-16568030d1d1\",\r\n \"blockedUntil\":\"2024-05-01T23:59:59\",\r\n \"properties\": {\r\n \"block_reason\": \"self excluded\"\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/events/TheQueue"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 31 Aug 2023 13:08:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d20e2282-2486-45a1-9f86-6b487cd3d07c"},{"name":"USER_BLOCKED_TOGGLE","id":"7bd6047c-07ce-46c7-8a1c-66c754fc1f88","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"USER_BLOCKED_TOGGLE\",\r\n \"mappingSelector\": \"{mappingName}\",\r\n \"contactId\": \"{originalId}\",\r\n \"blocked\": true|false,\r\n \"properties\": {\r\n \"attributeName1\": \"value1\",\r\n \"attributeName2\": \"value2\"\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/events","description":"A USER_BLOCKED_TOGGLE event will add a temporary block to a contact, meaning no messages (in any channel) will be created and sent until you release the block.
\nTo release a block, simply send \"blocked\": false.
This event can be mapped to the type Block in the Symplify interface including actions like Create contact, Update contact or Upsert contact.
\n","urlObject":{"path":["{{customerId}}","events"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8eb79bcd-8622-4754-9734-9a8396997968","name":"USER_BLOCKED_TOGGLE","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"USER_BLOCKED_TOGGLE\",\r\n \"mappingSelector\": \"block_toggle\",\r\n \"contactId\": \"8a6c62bc-6664-447d-2c48-16568030d1d1\",\r\n \"blocked\": true,\r\n \"properties\": {\r\n \"block_reason\": \"self excluded\"\r\n }\r\n}"},"url":"{{url}}/{{customerId}}/events/TheQueue"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 31 Aug 2023 13:10:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7bd6047c-07ce-46c7-8a1c-66c754fc1f88"},{"name":"BATCH NOTIFICATION","id":"3a53f357-03c9-4275-91c1-7cda899cb45f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"BATCH_NOTIFICATION\",\n \"mappingSelector\": \"{mappingName}\",\n \"downloadUri\": \"{http://yourdomain.com/folder/file}\"\n}"},"url":"{{url}}/{{customerId}}/events/\n","description":"Please note that this event type is not available over HTTP.
\nA selection of contacts made in some other system may be pushed to Event hub in a batch using the type BATCH_NOTIFICATION.
\nTo set up the events in Symplify, select the mapping type \"Batch\":
\nThis type can be mapped to perform any of the actions:
\n- \n
Enter journey
\n \nExit journey
\n \nDatabase import
\n \n
You will provide a downloadUri with the path of your file. The data file is expected to be an UTF8-encoded text file where each line is in a JSON object.
\nAny contacts not already present in the system will be automatically created; already existing contacts will be \"touched\".
\nThe \"id\" attribute of each JSON object in the file represents the original id of the contact.
\nExample data:
\n{\"id\": \"0\", \"properties\": {\"emailAddress\": \"the_boss@example.com\", \"firstname\": \"Bruce\", \"attributeName\": \"yes\"}}\n{\"id\": \"1\", \"properties\": {\"emailAddress\": \"aretha.f@example.com\", \"firstname\": \"Aretha\", \"attributeName\": \"yes\"}}\n{\"id\": \"2\", \"properties\": {\"emailAddress\": \"ladygaga@example.com\", \"firstname\": \"Lady\", \"attributeName\": \"no\"}}\n\nWhen using any of the journey actions, please note that custom attribute data will not update the contacts, but will be available for use in placeholders within the journey.
\n","urlObject":{"path":["{{customerId}}","events","\n"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"51ce98bc-eda2-480b-b7d1-c38b862ebc46","name":"BATCH NOTIFICATION","originalRequest":{"method":"POST","header":[{"key":"X-Carma-Authentication-Token","type":"text","value":"{{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"BATCH_NOTIFICATION\",\n \"mappingSelector\": \"shipping\",\n \"downloadUri\": \"http://domain.com/folder/batch_12345.txt\"\n}"},"url":"{{url}}/{{customerId}}/events/TheQueue\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 31 Aug 2023 14:10:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3a53f357-03c9-4275-91c1-7cda899cb45f"}],"id":"fe997050-e2d5-41db-8f60-3be650558b5b","description":"Overview
\nThe Event hub functionality is perfect if you want to react quickly to events originating from your system, and need data in Symplify to be as up-to-date as possible at every single point in time. It's ideal if you already have a message broker where you publish application events, or if you want to avoid explicit integration with the Symplify REST API.
\nIn an Event hub setup, Symplify is configured to listen for messages from a Message Broker (SQS or RabbitMQ), and instructed to take actions depending on incoming messages. As long as the incoming message format follows the recommended format described here, no additional integration is required.
\nBest practice is to send this data via AWS SQS, but if this is not possible the REST API mimics this functionality. The same payload is used but some benefits of the message broker are lost.
\nYou will send a Payload containing the data and then set a MappingSelector that will be used to map the data to one or more Actions in Symplify. I.e. you can send an event containing a GENERIC_USER payload with the MappingSelector \"CreateUser\". In Symplify you can them map this to the CreateUser action and the EnterJourney action and both these actions will be executed when an event comes in.
\nThe mappingSelector is an arbitrary string that you choose. This way you will not have to decide at implementation time how the data shall be mapped. If no mappingselector is set, it will default to the same value as the Type field.
\nConfiguration
\nThe configuration is made using the Symplify admin interface and includes:
\n- \n
- Endpoint identifier/URI/Queue identifier \n
- Authentication information
- \n
- For SQS, this will be the key + secret key of an AWS IAM user with read access to the specified queue. Alternatively, you can grant read access on your queue to our AWS account, which completely eliminates the need for credentials registration in Symplify. \n
- For RabbitMQ this will be username/password for a user with read access to the specified queue \n
- For HTTP requests you will use the same authentication method as you do for all other requests through the Symplify REST API (X-Carma-Authentication-Token)
The payload will be the same as the examples in this documentation. \n
\n - Action mapping
The setup for how each event should be managed in Symplify. Learn more on Expertise. \n
It is possible to set up multiple queues if you have data from different sources. If your queue is not converted from an older setup (named DEFAULT) you must include the queue name in your endpoint.
\nExample posting to a queue:
\n{{url}}/{{customerId}}/events/{queueName}
If you have converted an older setup (where only one queue was allowed) you will automatically get a queue called DEFAULT. Example posting to the DEFAULT queue:
\n{{url}}/{{customerId}}/events
Message broker event processing
\nEvents are processed in the order they are received from the message broker. We will rely on the message broker to ensure proper ordering and \"only once\" delivery of events. This means that if the broker delivers the exact same event message more than once (\"at least once\" message delivery), both of these events will be processed. This is something that needs to be taken into account when setting up this kind of integration. We recommend using a message broker that supports ordered, \"only once\" message delivery.
\nEvents and format
\nIncoming event payloads need to be in JSON format. We highly recommend using the default event format described in this documentation.
\nIf you find it impossible to produce events in the default event format, Symplify can implement a custom message converter at additional costs.
\nAll messages that you want a custom Symplify message converter to consume will need to be typed either through a header attribute or a message attribute, depending on the technology used by your message queue. Your custom event format will be transformed using the custom-built converter to the standard events described below. Consequently, for us to be able to implement a custom converter, we do need the events from your system to contain all the necessary information needed to populate our standard event objects.
\nAll events must contain:
\n- \n
- Type
Defines the content and structure of the data \n - Mapping selector
Maps the event to handle the data as requested in the Symplify interface. \n - Event specific data
Depending on the event the specific data may vary. \n
Terminology
\n- \n
- Symplify API - The main Symplify REST API. \n
- Event API - The Symplify CRM Event REST API \n
- Contacts - A representation of your users in Symplify. \n
- Users - Users of your application. Represented as Contacts in Symplify. \n
This documentation covers all available events with example payloads.
\n","event":[{"listen":"prerequest","script":{"id":"e9c32e80-29de-418e-985f-cb96f8eb39b5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ecd0ff62-ca53-4a17-9514-8e3c64a7dbda","type":"text/javascript","exec":[""]}}],"_postman_id":"fe997050-e2d5-41db-8f60-3be650558b5b"},{"name":"Web Push","item":[{"name":"Web Push REST API","item":[],"id":"cb499346-6590-433b-b95d-63b038f66ca0","description":"The Web Push REST API allows integrating systems to retrieve, update and delete Web Push messages - as well as subscribing webhooks to handle incoming messages - on a per contact basis.
\nRead the full documentation here
\n","event":[{"listen":"prerequest","script":{"id":"cfb5a949-5bbd-4c05-961d-2aba14496092","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d5035351-8e28-4a09-8c25-c08cdac2298a","type":"text/javascript","exec":[""]}}],"_postman_id":"cb499346-6590-433b-b95d-63b038f66ca0"},{"name":"Web Push JS","item":[],"id":"064499e0-6f3a-4550-8029-da85c2f27bb4","description":"The Web Push JS Library allows integrating messaging and Inbox functionality.
\nRead the full documentation here
\n","event":[{"listen":"prerequest","script":{"id":"d66155f2-dbbf-42e9-ae55-9d5031be9575","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"184129ab-1aba-403c-a8b4-be83c5bd3fd8","type":"text/javascript","exec":[""]}}],"_postman_id":"064499e0-6f3a-4550-8029-da85c2f27bb4"}],"id":"5e6e4472-9548-45c8-ba73-4ba629ab8c4f","description":"Symplify Web Push messaging enables you to Pop Up when your customer is on site.
You can for example use Symplify Web Push to inform selected customers that they have an active offer available, tips and tricks within the platform or showcasing features based on the recipient profile.
You can of course personalize all messages and use the different Symplify modules, like Journeys and Campaigns to generate your Symplify Web Push messages.
\n- \n
Create welcome messages for new users with link and instructions for navigating the app or best use the application
\n \nSend a reminder that pops up after login so they remember to complete their registration with credit card, loyalty card and shipping address etc.
\n \nShowcase new features and encourage users to try them out
\n \nSend coupons and offers
\n \nRemind customers of abandoned carts or loyalty credits on their accounts
\n \nOffer order tracking after sales
\n \n
Please note that appType is not mandatory in the payload but must be included if you have multiple apps (on different platforms) sharing appId.
\nappId 1 = iOS
appId6 = Firebase
{ \"originalId\": \"abcdefghijklmno\", \"deviceInfo\": [ { \"devicetoken\": \"abc123\", \"appType\": 6 } ]
Please note that appType is not mandatory in the payload but must be included if you have multiple apps (on different platforms) sharing appId.
\nappId 1 = iOS
appId6 = Firebase
{ \"originalId\": \"abcdefghijklmno\", \"deviceInfo\": [ { \"devicetoken\": \"abc123\", \"appType\": 6 } ]
This document describes how to integrate Symplify with Google's Firebase push notifications and how to manage enduser devices in Symplify.
\nHow Firebase Cloud Messaging (FCM) works
\nFirebase is backend platform for building web, Android and IOS applications. It offers real time database, different APIs, multiple authentication types and hosting platform.
Google’s system considers three parties:
- \n
The client application
\n \nGoogle's FCM servers
\n \nA 3rd party server, in this case Symplify.
\n \n
When a user installs an application, it must register itself to enable FCM. Once done, as soon as you decide to send your users a notification, a succession of actions are triggered:
\n- \n
Symplify sends the push notification to Google's FCM servers.
\n \nThese servers relay the message to all your registered mobile applications.
\n \nMessages are queued and stored for devices that are offline.
\n \nAs soon as a device comes back online, FCM servers relay the queued message.
\n \nThe messages are received and presented according to the platform-specific implementation.
\n \n
Firebase Cloud Messaging overview
\nFCM is a service provided by Google that helps developers implement push notifications in their applications. By using FCM, developers are not required to implement their own method for sending data from their server to the client applications.
\nYour App server > FCM > device running your client application
\nBoth the app server and the client need to register with FCM and provide information to uniquely identify and authorize them. Your app will need a Package name and your server will need a Private key (JSON) for your Service account, both of which can be obtained using the Firebase Developers Console.
\nIntegration overview
\nBefore you begin, you will need to have an app that you want to send push notifications to:
\n- \n
The app is registered with Google and is given an appName.
\n \nThe app is registered in Symplify using the appName and the Firebase Private Key.
\n \n
The app code:
\n- \n
The app requests a token from FCM
\n \nThe App sends this token to Symplify along with the appName.
\n \nThe token is stored in Symplify and associated with the app and the originalId.
\n \n
Configuring the project in Firebase Developers Console
\nThe first step to the implementation is to integrate Firebase notifications with your app, please follow the Firebase's tutorial (see Add Firebase to an app).
\nTwo services should be added to use Firebase Cloud Messaging service: a basic code for testing if push notification works, and other codes to handle receiving message when you app is in the foreground or sending message in your app according to your design. You must also implement code that will receive notifications when the app is in the background.
\nWhen you have succesfully sent a test message within the Firebase test environment you are ready to move on and write the Symplify specific code.
\nWrite the Symplify specific code
\nSymplify credentials
\nThe code above is generic for any push notification implementation. There are some additional tasks you need to perform in order to integrate your app with Symplify.
\nBefore you start coding you will need to find four pieces of data that are used in all interactions with Symplify.
\nThe first is the appName, e.g. com.somecompany.app.
To find the other three you will need to login to Symplify. The data is:
- \n
REST URL (restUrl)
\n \nSymplify API Key, embedded token in Mobile app (carmaAccessToken)
\n \nCustomer ID (customerId)
\n \n
The first two can be found in Symplify under Account Settings > Symplify API.
If you haven’t created an API key before, click the Create New button to add a new one and for security reasons, make sure you have ticked the \"Only for use as embedded token in Mobile app\".
Your customer ID is found on the dashboard in Symplify.
The usage of this information is described in a chapter below.
Request headers
\nAll calls to Symplify need three request headers.
\nThe resource uses a custom header for authentication and need you to set the Content-Type and Accept headers to application/json
HttpPut post = new HttpPut(url);\npost.setEntity(se);\npost.setHeader(\"Accept\", \"application/json\");\npost.setHeader(\"Content-Type\", \"application/json\");\npost.setHeader(\"X-Carma-Authentication-Token\", accessToken);\n\nAll calls to Symplify are REST calls. Java has multiple ways to implement REST, so you will need to choose one to your liking. The examples below uses a bare metal method to give some idea on how this could be implemented.
\nRegistration
\nYou can now begin coding. The first thing you need to do is to send the Firebase token to Symplify. The token is received via the Firebase SDK using the MyFirebaseMessagingService class.
This token needs to be registered in Symplify along with the appId and an originalid of your choosing. The originalid is the key identifier of the contact in Symplify.
\nYou register a token by issuing a PUT request to:
https://{url}/rest/{customerid}/apps/{appid}/devices
with a json payload containing at the minimum:
\n- \n
deviceToken
\n \noriginalId
\n \n
NOTE! Even if they are the same both values must be provided.
\nA minimal version of the payload would look like this:
\n{\n\"originalId\": \"123456\",\n\"deviceInfo\": [{\"devicetoken\": \"abcdefghijklmno\"}]\n}\n\nNOTE! If you use the same appId for apps of different platforms, e.g. com.company.name for both iOS and Android, you must add the appType to the token.
The appType can be found in Symplify under Account settings > Push.
For a Firebase integration, the appType value is 6.*
The payload will then be:
\n{\n\"originalId\": \"123456\",\n\"deviceInfo\": [{\"devicetoken\": \"abcdefghijklmno\", \"appType\": \"6\"}]\n}\n\nIn this payload you can also add other information about the user that should be transferred to Symplify.
Below is the full list of available properties.
{\n\"listId\": 1000000005,\n\"country\": null,\n\"originalId\": \"123456\", \n\"firstName\": \"value\",\n\"lastName\": \"value\",\n\"middleName\": null,\n\"emailAddress\": \"name@domain.com\",\n\"title\": null,\n\"dateOfBirth\": null,\n\"city\": null,\n\"zipcode\": null,\n\"sex\": null,\n\"mobileNumber\": null,\n\"optOutDate\": null,\n\"dateOfInvalidation\": null,\n\"optOutMobileDate\": null,\n \"active\": true,\n \"properties\": {\n \"attributeName1\": \"value\",\n \"attributeName2\": \"value\"\n },\n \"deviceInfo\": [{\n\"devicetoken\": \"abcdefghijklmno\",\n\"manufacturer\": \"apple\",\n\"model\": \"iphone 6\",\n\"osVersion\": \"9.2\",\n\"country\": \"Sweden\", \n\"dateOfInvalidation\": null,\n\"appInfoId\": 1001,\n\"invalidationType\": 0\n}]\n}\n\nThe same structure is used to return info on the device, but it is then appended with all devices that is connected to the contact (more details given later in the document).
\nThe following code can be used for the registration:
\nprivate void registerDeviceAndProfile(CarmaUserProfile profile) {\nHttpClient client = new DefaultHttpClient(); JSONObject parent = new JSONObject(); JSONArray deviceInfo = new JSONArray(); JSONObject token = new JSONObject();\nString packageName =\"com.your.packagename\";\nString accessToken =\"234kj5h345jh3kj532kjh5g35345\";\ntry {\ntoken.put(\"devicetoken\", profile.getToken()); deviceInfo.put(token); parent.put(\"deviceInfo\",deviceInfo); parent.put(\"originalId\", profile.getOriginalId()); parent.put(\"emailAddress\",profile.getEmail()); parent.put(\"mobileNumber\",profile.getMobile());\n} catch (JSONException e) { e.printStackTrace();\n}\nfinal String url = Constants.server + \"/rest/\" +new Integer(Constants.customerId).toString() + \"/apps/\"+packageName+\"/pushdevices\";\nStringEntity se; try {\nse = new StringEntity( parent.toString(),\"UTF8\");\nse.setContentType(new BasicHeader(HTTP.CONTENT_TYPE, \"application/json\")); se.setContentEncoding(\"UTF8\");\n} catch (UnsupportedEncodingException e) { e.printStackTrace();\nreturn;\n}\nHttpPut post = new HttpPut(url);\npost.setEntity(se);\npost.setHeader(\"Accept\", \"application/json\"); post.setHeader(\"Content-Type\", \"application/json\"); post.setHeader(\"X-Carma-Authentication-Token\", accessToken); try {\nfinal HttpResponse response = client.execute(post); StatusLine line = response.getStatusLine();\nfinal int code = line.getStatusCode(); StringBuilder sb = new StringBuilder();\ntry {\nBufferedReader reader =\nnew BufferedReader(new InputStreamReader(response.getEntity().getContent()), 65728);\nString cline = null;\nwhile ((cline = reader.readLine()) != null) {\n sb.append(cline);\n }\n}\ncatch (IOException e) { e.printStackTrace(); } catch (Exception e) { e.printStackTrace(); }\n} catch (ClientProtocolException e) { e.printStackTrace();\n} catch (IOException e) { e.printStackTrace();\n} catch (Exception e) {\n} }\n\n*Other valid values for appType are 1 (iOS), 2 (Android) and 3 (Windows).
\nInvalidation of a devicetoken
\nIf you want to remove a registration of a devicetoken for an OriginalId you can issue a PUT request to
https://{url}/rest/{customerid}/apps/{appid}/devices/invalidation
with a json payload containing at the minimum:
\n- \n
deviceToken
\n \noriginalId
\n \n
{\n\"deviceInfo\":[{\"devicetoken\": \"abcdefghijklmno\"}],\n\"originalId\":\"abc123\"\n}\n\n(Not invalidated expired tokens are simply ignored by Firebase.)
\nRetrieving information about a contact
\nFor security reasons, mobile app API tokens are not allowed to retrieve any data about a contact to the app. Fetching data about a contact should instead be done by your main system using a regular Symplify API token (never use a regular API token within your app):
\nGET https://{url}/rest/{customerid}/lists/{listId}/contacts/{originalId}
which will include device info.
\nYou will receive the same structure as when you register a device. It will contain a list of all devices registered on the originalId. If you have imported information by other means e.g. via scheduled import on the list, this data will also retrieved.
\nReceive push
\nA Symplify push message contains the following fields:
\n- \n
alert
\n
intended to be the line shown next to the icon in the notification \nbody
\n
intended to be the line shown under the first in the notification \nurl
\n
the url pointing to the actual rich content of the push \npushreadurl
\n
to mark a message as opened you will need to issue aGETrequest to thepushreadurl(or if you prefer to manage opens via Rich content (learn more below)). \nsource
\n
will always be “carma”. This should be used to distinguish between push messages that comes from other systems than Symplify (previously Carma). \nany other custom name/value pair that you have supplied in the Symplify UI for the push.
\n \n
It’s important to remember that it’s up to the application developer to decide how these fields should be used.
\nApp setup in Symplify
\nFind your way to Account Settings > Push and click Create new and add the necessary details for your app.
\nTo register your app in Symplify you will need:
\n- \n
Name
\n
The name of your app (for your orientation) \nApp ID
\n
The application id \nAPI key
\n
Deprecated functionality \nMain activity
\n
Android required class for activities \n**Service account
\n
**Your private key from Firebase to setup the connection. Learn more. \n
Click Create and you are ready to start sending Push requests to you users.
\nTesting and troubleshooting
\nOnce you have done integration, perform the following tests.
\n- \n
Install the application on a new device
\n \nNotice that the number of recipients increases for each time you do this. If not, check that the id’s you supply are correct. Check also that the appid you gave when registering the application is the same as the package given in the top of your manifest.
\n \nIf the list does grow, test a simple push while the application is running. If a notification does not show up after a few minutes, make sure that you have given the correct API key when registering the app in Symplify.
\n \nOnce the above works correct, verify that the notifications show up when sending a push even though the application is not running.
\n \n
Additional integration option
\nRich content
\nNormally when a push notification is received you open up the app by clicking on the notification. Symplify offers the option to select whether the app or the Rich content of a landing page should open. The Rich content can be personalized offers leading to the app or wherever that offer can be reached.
\nRich content is edited in Symplify together with the specific push notification.
\nWhen a landing page should open can be managed with predefined key/value pairs.
\nTo fetch the Rich content of a notification you simply call the URL that is received in the url field in the notification.
\nContent
\nThe content of a push message is not sent in the push itself, but is located at server side where the URL in message is pointing. Content is usually a page of HTML that is generated for the particular device, from a template of the server side. It could however be XML or other text-based formats as defined by template.
\nThe most common way to handle content is to simply open an webview and pointing it to the URL, making it display the page. The developer could however choose to handle it in different ways. Examples would be opening the device browser instead by an intent, downloading the content and parsing it to extract information that is used in the application or passing it to another application.
\nLoading rich content will mark the notification as opened.
\nLoad rich content
\nBy looking for the extra parameter URL when starting the main activity you can retrieve the link to rich content. The code below starts an activity AddWebView with the URL as a parameter when a push is received.
\nprotected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState);\nBundle extras = getIntent().getExtras();\nif ( extras != null) {\nString url = extras.getString(\"url\"); if (url != null) {\nif (url != null) {\nIntent i = new Intent(getBaseContext(), AddWebViewActivity.class); i.putExtra(\"url\", url);\nstartActivity(i);\n} }\n\nBelow is the code for an AddWebView activity that shows the rich content in a new WebView
\npublic class AddWebviewActivity extends AppCompatActivity {\nprivate static final String TAG = ContentActivity.class.getSimpleName(); @Override\npublic void onCreate(Bundle savedInstanceState) {\nsuper.onCreate(savedInstanceState); setContentView(R.layout.activity_content); Bundle extras = getIntent().getExtras(); String url = extras.getString(\"url\");\nif (!TextUtils.isEmpty(url)) {\nWebView view = (WebView) findViewById(R.id.rich_content_webview);\nview.invokeZoomPicker();\nWebSettings settings = view.getSettings(); settings.setJavaScriptEnabled(true); view.setScrollBarStyle(WebView.SCROLLBARS_OUTSIDE_OVERLAY); view.getSettings().setLoadWithOverviewMode(false); view.getSettings().setUseWideViewPort(false); view.setWebContentsDebuggingEnabled(false);\ntry {\nview.loadUrl(url); } catch(Exception ex) {\n//Log.e(TAG, ex.getMessage());\n} }\n}\n\n