{"_id":"5aba855ed51b970080b7f3ba","project":"55843604fd8d910d007b9502","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":71,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136","599c6da8f180820025f14909","59b054613c3e1b0019cf27d9","59b1ceca2d6231003ad73e5f","59b1cf1857911600382e0dc4","59b1cf2730f3d60010c30ef7","59b1cf385d4b89003035441a","59b1cf5857911600382e0dc6","59bc2c4e26ac9b0010a8b753","59bc2ce20b3eb30010657b70","59f0c793ba3bc90030f413ab","59f0cd62f5ecda00325294b9","59fb55a8e8d0f600101aedc3","59fcb05c067f8d0028613f86","5a2af4a1bc5fba00283909c1","5a83673b0e56010012138c12","5a972f2e77b85a0070e4ebe2","5aa300224ed4b40012c53e1d","5acd20095efd8d000359bb3c","5ad50889c05179000306021e","5af0927a8779670003daff34","5b55a46b282b25000319669e","5ba4b423a1a8660003a6b4dd","5ba969b5bdd51d0003cf152c","5bb87f6ea7fe7b0003b86e02","5bbf51fee658fb000339f503"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"5aa300224ed4b40012c53e1d","project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-03-09T21:44:02.064Z","from_sync":false,"order":54,"slug":"target-audience-custom-contact-frequency","title":"iQ Directory Custom Contact Frequency"},"user":"558435c2fb52ee0d0015d190","githubsync":"","__v":4,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-27T17:54:38.964Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"code":"curl 'https://yourdatacenterid.qualtrics.com/API/v3/directories/POOL_012345678901234/frequencyrules/FQ_012345678901234' \\\n-X PUT \\\n-H 'X-API-TOKEN: yourtokenhere' \\\n-H 'Content-Type: application/json' \\\n-d '{\"targetType\": \"MailingList\", \"targetIds\": [\"CG_AF6812D687\", \"CG_GYESF468SD\"], \"emailType\": \"Invite\", \"daysBetween\": 8, \"alwaysSend\": false, \"timePeriodLimit\": {\"period\": \"Month\", \"numMessages\": 23 }}' ","language":"curl"}]},"results":{"codes":[{"name":"","code":"{\n    \"meta\": {\n        \"httpStatus\": \"200 - OK\",\n        \"requestId\": \"41befb3e-71c4-4234-b00e-dd17117c4798\"\n    }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5aba855ed51b970080b7f3c0","ref":"","in":"body","required":true,"desc":"The targetType for this rule. Must be ONE of the following: Directory, MailingList, Survey","default":"","type":"string","name":"targetType"},{"_id":"5aba855ed51b970080b7f3bf","ref":"","in":"body","required":true,"desc":"The ids of the target. For mailing lists, this will be mailing list ids, for directories this will be directoryId, for surveys this will be surveyId","default":"","type":"array_string","name":"targetIds"},{"_id":"5aba855ed51b970080b7f3be","ref":"","in":"body","required":true,"desc":"The types of email the rule applies to. Valid values are: Invite or Email. Email is for any email message, including Invites.","default":"","type":"string","name":"emailType"},{"_id":"5aba855ed51b970080b7f3bd","ref":"","in":"body","required":false,"desc":"The days between invites or emails.","default":"","type":"int","name":"daysBetween"},{"_id":"5aba855ed51b970080b7f3bc","ref":"","in":"body","required":false,"desc":"Defines the maximum number of messages a contact can receive in a given time period. This is a object with two fields: period, numMessages. numMessages is an integer and period can be Day, Week, or Month","default":"","type":"object","name":"timePeriodLimit"},{"_id":"5aba855ed51b970080b7f3bb","ref":"","in":"body","required":false,"desc":"Turns on alwaysSend. If turned on, when this ContactFrequency rule conflicts with another ContactFrequency rule, this distribution will ignore the conflict and send the distribution.","default":"false","type":"boolean","name":"alwaysSend"},{"_id":"5aba878ad51b970080b7f447","ref":"","in":"path","required":true,"desc":"The directory ID, also known as a pool ID","default":"","type":"string","name":"directoryId"},{"_id":"5aba878ad51b970080b7f446","ref":"","in":"path","required":true,"desc":"The contact frequency Rule ID","default":"","type":"string","name":"ruleId"}],"url":"/v3/directories/:directoryId/frequencyrules/:ruleId"},"isReference":false,"order":3,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Limitations on number of targetIds\",\n  \"body\": \"The targetIds field only accepts 20 ids per call.\\nIf the target is a directory, it must match the directory of the User making the call\"\n}\n[/block]","excerpt":"","slug":"update-contact-frequency-rule","type":"endpoint","title":"Update Contact-Frequency Rule"}

putUpdate Contact-Frequency Rule


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

directoryId:
required
string
The directory ID, also known as a pool ID
ruleId:
required
string
The contact frequency Rule ID

Body Params

targetType:
required
string
The targetType for this rule. Must be ONE of the following: Directory, MailingList, Survey
targetIds:
required
array of strings
The ids of the target. For mailing lists, this will be mailing list ids, for directories this will be directoryId, for surveys this will be surveyId
emailType:
required
string
The types of email the rule applies to. Valid values are: Invite or Email. Email is for any email message, including Invites.
daysBetween:
integer
The days between invites or emails.
timePeriodLimit:
object
Defines the maximum number of messages a contact can receive in a given time period. This is a object with two fields: period, numMessages. numMessages is an integer and period can be Day, Week, or Month
alwaysSend:
booleanfalse
Turns on alwaysSend. If turned on, when this ContactFrequency rule conflicts with another ContactFrequency rule, this distribution will ignore the conflict and send the distribution.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Limitations on number of targetIds", "body": "The targetIds field only accepts 20 ids per call.\nIf the target is a directory, it must match the directory of the User making the call" } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}