{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/contact_renewal_reminders","auth":"required","results":{"codes":[{"status":201,"language":"json","code":"{  \n  \"id\":100,\n  \"contact_id\":200,\n  \"active\":true,\n  \"next_due_at\":\"2014-10-08T00:00:00.000-05:00\",\n  \"last_sent_at\":\"2016-09-29T07:36:04.174-05:00\",\n  \"created_at\":\"2013-04-22T14:21:10.091-05:00\",\n  \"updated_at\":\"2016-09-29T07:36:04.174-05:00\",\n  \"contact_renewal_type_id\":300,\n  \"due_soon_at\":\"2014-09-17T00:00:00.000-05:00\",\n  \"due_soon_time_threshold_interval\":3,\n  \"due_soon_time_threshold_frequency\":\"weeks\",\n  \"account_id\":1,\n  \"archived_at\":null\n}","name":""},{"status":422,"language":"json","code":"{\n  \"errors\": []\n}","name":""}]},"settings":"","params":[{"name":"contact_id","type":"int","default":"","desc":"","required":true,"in":"body","ref":"","_id":"596ce978dad7bc0029a9a454"},{"name":"contact_renewal_type_id","type":"int","default":"","desc":"","required":true,"in":"body","ref":"","_id":"596ce978dad7bc0029a9a453"},{"name":"active","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"596ce978dad7bc0029a9a452"},{"name":"next_due_at","type":"yyyy-mm-dd","default":"","desc":"","required":true,"in":"body","ref":"","_id":"596ce978dad7bc0029a9a451"},{"name":"due_soon_at","type":"yyyy-mm-dd","default":"","desc":"","required":false,"in":"body","ref":"","_id":"596ce978dad7bc0029a9a450"},{"name":"due_soon_time_threshold_interval","type":"int","default":"","desc":"Used in conjunction with due_soon_time_threshold_frequency. Together they form a full due soon parameter. Ex: \"1 weeks\", \"5 months\", \"10 years\"","required":false,"in":"body","ref":"","_id":"596ce978dad7bc0029a9a44f"},{"name":"due_soon_time_threshold_frequency","type":"string","default":"","desc":"Valid options: days, weeks, months, years","required":false,"in":"body","ref":"","_id":"596ce978dad7bc0029a9a44e"}],"examples":{"codes":[]},"method":"post"},"next":{"description":"","pages":[]},"title":"/contact_renewal_reminders","type":"endpoint","slug":"create-contact-renewal-reminder","excerpt":"Creates a new contact renewal reminder.","body":"","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"596ce8df4e23ca00152fc7d6","project":"54c0e51215af820d001a38a6","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54f8de4e4339bb1900c8bffc","54f8de4e4339bb1900c8bffd","54f8de4e4339bb1900c8bffe","54f8de4e4339bb1900c8bfff","54f8de4e4339bb1900c8c000","54ff6057563d7419002d666e","55007b6ecfeeea17004717dc","5501d779f2ef1e0d003116eb","55116ef89f7c7619005f853b","554bb366f245703100ddd39f","554d226b374fec0d007e64db","555e09f18ab3180d001ac605","555e0b2b4f5e5a0d00836d77","561d1f8b92a0cc350018b24f","562a956c96b5f40d0026eb60","5654c3378a26202b00c17cb8","5697a94b0b09a41900b24546","5739d89e37b52e3200a3a3cc","57ac94252c0b220e00a94570","57ac97a1ad44fc0e003be066","57ac9a3a8f312d0e00e96c75","57ac9c187ae5c60e004ba3a3","58178bee62e4500f009404f6","581a39711a63870f008b621d","581a3b4f0c65b20f00247fcb","5926e0606c729e0f00595f95","5954033ea5bbca002d27ae91","596ce53e0aeafe00157eb1ba","596ce87a8b79f4001a8f6139","598cad2e96193400190d879a","598cbcd3dc20c6000fdfb9c3","598cbd8496193400190d8955","59fcc7c9591add0026c91457","5a020b7856ea82001c8c9342","5a09bc64a91882001c56c2ed","5a71fa2de9aa84007a8bccdb","5b3a768a8a21dd0003ca080d","5c7030f099eeb6003116a106","5c9553a7b6957d005006fc09","5c955c3d04233b0063c9f450","5cfe73f7823bba005de7e1ed","5d07eb760568e70040d6ae21","5deec6550e90370067139979"],"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","releaseDate":"2015-03-05T22:53:02.044Z","createdAt":"2015-03-05T22:53:02.044Z","forked_from":"54f8de14c6cabe23005c02a2","__v":39},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Contact Renewal Reminders","slug":"contact-renewal-reminders","order":7,"from_sync":false,"reference":false,"_id":"596ce87a8b79f4001a8f6139","project":"54c0e51215af820d001a38a6","version":"54f8de4e4339bb1900c8bffb","createdAt":"2017-07-17T16:40:26.721Z","__v":0},"user":"560000e90c703d1900952ff2","createdAt":"2017-07-17T16:42:07.074Z","githubsync":"","__v":3,"parentDoc":null}

post/contact_renewal_reminders

Creates a new contact renewal reminder.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

contact_id:
required
integer
contact_renewal_type_id:
required
integer
active:
boolean
next_due_at:
required
yyyy-mm-dd
due_soon_at:
yyyy-mm-dd
due_soon_time_threshold_interval:
integer
Used in conjunction with due_soon_time_threshold_frequency. Together they form a full due soon parameter. Ex: "1 weeks", "5 months", "10 years"
due_soon_time_threshold_frequency:
string
Valid options: days, weeks, months, years

Result Format


User Information

Try It Out

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