Relations Paths

Get relations paths

GET /relations-paths

Response
Status code 200

{
  "data": [
    {
      "id": "9eae431b-3d0f-4528-9c59-e9d1a40fcd04",
      "name": "Case type",
      "is_sales_type": true,
      "activity_types": {
        "milestones": [
          {
            "id": "a203539b-f06c-442c-8ad0-f5a56f0615f6",
            "name": "Contract",
            "sort_order": 1,
            "set_status": "closed",
            "suggest_task_after": 172800,
            "milestone_types": [],
            "jumpoff": {
              "button_text": "My DMS",
              "target_url": "http://mydms.example.com/"
            },
            "content_suggestions": [
              {
                "id": "17498b87-d835-4a97-9428-24ae1dcfd9a5",
                "type": "email",
                "name": "Welcome",
                "subject": "Hi",
                "content": "Hi\nThis is great!!",
                "template_id": 13
              },
              {
                "id": "7447f327-5dae-4276-8a87-8c8a6c9ed793",
                "type": "email",
                "name": "Hi 2",
                "subject": "Hi 2",
                "content": "WOW!",
                "template_id": null
              }
            ],
            "extra_step": null,
            "additional_steps": null,
            "chance_of_success": 100
          },
          {
            "id": "943cef92-f9b4-4fcb-b4e4-834f34915973",
            "name": "Some other milestone",
            "sort_order": 2,
            "set_status": "open",
            "suggest_task_after": 172800,
            "milestone_types": [],
            "jumpoff": null,
            "content_suggestions": [
              {
                "id": "5d0a2b97-cec8-4e77-bb32-624ed9e6edc9",
                "type": "email",
                "name": "agency",
                "subject": "This is a subject",
                "content": "This is the content",
                "template_id": null
              }
            ],
            "extra_step": [
              {
                "id": "de4bb6f0-b5f4-4a7d-940d-dbeef24e3ac0",
                "sort_order": 1,
                "name": "Lets do this"
              },
              {
                "id": "c8c7c9d3-8f6b-4e35-9fad-726f1918cd8d",
                "sort_order": 2,
                "name": "Get coffe"
              },
              {
                "id": "c05440df-15e5-4d29-910a-a8f5d598f0d9",
                "sort_order": 3,
                "name": "Extra step"
              }
            ],
            "additional_steps": [
              "correspondence"
            ],
            "chance_of_success": 30
          }
        ],
        "supportive": [
          {
            "id": "f4aaf74a-59c6-409b-8990-54b78eae1c75",
            "name": "Supportive",
            "sort_order": 2,
            "set_status": "open",
            "suggest_task_after": 172800,
            "content_suggestions": [
              {
                "id": "fe7f4d0f-3b56-4a28-bc6e-3f7648ac52fb",
                "type": "email",
                "name": "knox",
                "subject": "This is a subject",
                "content": "This is the content",
                "template_id": null
              },
              {
                "id": "b20c7a34-3821-47b5-a70c-f6a649b410ca",
                "type": "email",
                "name": "computer",
                "subject": "This is a subject",
                "content": "This is the content",
                "template_id": null
              }
            ],
            "extra_step": [
              {
                "id": "86247236-dc8f-4d4c-b406-fed9d7db97c3",
                "sort_order": 1,
                "name": "Write email"
              },
              {
                "id": "bd41fe6b-49c0-4ac1-987a-65c0a8ff238a",
                "sort_order": 2,
                "name": "Bring coffe"
              },
              {
                "id": "3b71a00f-adca-43e2-8d2b-99e3a2d4e572",
                "sort_order": 3,
                "name": "Call"
              }
            ],
            "additional_steps": null
          },
          {
            "id": "f4aaf74a-409b-59c6-4a28-54b78eae1c75",
            "name": "Supportive",
            "sort_order": 3,
            "set_status": "declined",
            "suggest_task_after": 172800,
            "content_suggestions": [],
            "extra_step": [
              {
                "id": "86247236-4d4c-b406-dc8f-fed9d7db97c3",
                "sort_order": 1,
                "name": "Declined because of something"
              },
              {
                "id": "3441fe6b-4ac1-49c0-987a-65c0a8ff238a",
                "sort_order": 2,
                "name": "Declined because of something other"
              },
              {
                "id": "3b71a00f-8d2b-43e2-adca-99e3a2d4e572",
                "sort_order": 3,
                "name": "Bah"
              }
            ],
            "additional_steps": null
          }
        ]
      },
      "default_template": {
        "email": null,
        "letter": null
      },
      "team_id": null,
      "created_at": "2015-03-04 11:51:19",
      "updated_at": "2015-03-04 11:51:19"
    }
  ]
}

Get a relations path

GET /relations-paths/:relations_path_id

Response
Status code 200

{
  "id": "9eae431b-3d0f-4528-9c59-e9d1a40fcd04",
  "name": "Case type",
  "is_sales_type": true,
  "activity_types": {
    "milestones": [
      {
        "id": "a203539b-f06c-442c-8ad0-f5a56f0615f6",
        "name": "Contract",
        "sort_order": 1,
        "set_status": "closed",
        "suggest_task_after": 172800,
        "jumpoff": {
          "button_text": "My DMS",
          "target_url": "http://mydms.example.com/"
        },
        "milestone_types": [],
        "content_suggestions": [
          {
            "id": "17498b87-d835-4a97-9428-24ae1dcfd9a5",
            "type": "email",
            "name": "Welcome",
            "subject": "Hi",
            "content": "Hi\nThis is great!!",
            "templates": [
              {
                "id": 1,
                "type": "letter",
                "company_id": 1,
                "title": "Letter template",
                "user_id": 1,
                "team_id": null,
                "group_id": null,
                "campaign": false
              }
            ]
          },
          {
            "id": "7447f327-5dae-4276-8a87-8c8a6c9ed793",
            "type": "email",
            "name": "meeting",
            "subject": "Booked meeting",
            "content": "Lets meet in the meeting room",
            "templates": null
          }
        ],
        "extra_step": null,
        "additional_steps": null,
        "automated_communications": [
          {
            "id": "fc52c6e5-4bc9-4773-95fd-d849331e8dcf",
            "team_id": 1,
            "name": ".",
            "description": "Est ut voluptates rerum",
            "icon": "So.",
            "communications": [
              {
                "name": "Est ut voluptates rerum. Aut veritatis reiciendis soluta. Corrupti fugiat atque eaque. Quo minus magnam saepe.",
                "delay": {
                  "days": 107,
                  "offset_from_midnight": 14106
                },
                "template_id": 2,
                "subject": "Hic in ullam ut consectetur.",
                "content": "Dolore enim adipisci voluptatem quasi nesciunt. Iste blanditiis et et quos libero modi sed.\nAliquid quod optio eos iure officia aut. Atque aut ut atque commodi nemo voluptatem officia enim. Veritatis deleniti earum optio."
              },
              {
                "name": "Iusto vero maxime ducimus sed. Inventore ullam saepe iusto exercitationem. Voluptatibus nulla et corrupti ad error qui.",
                "delay": {
                  "days": 89,
                  "offset_from_midnight": 9589
                },
                "template_id": 2,
                "subject": "Ratione molestias impedit et quis iusto.",
                "content": "Dolor veniam sit commodi illo dolorum laborum. Sunt tenetur nihil amet qui ut aut. Quia qui aut ut. Ducimus distinctio cupiditate quis tempora. Sint mollitia magni cumque amet aut.\nUt veniam error laborum. Iste nobis sapiente sunt amet quia optio illo."
              },
              {
                "name": "Illo in aspernatur quisquam amet cum consequatur. Iusto quam veniam blanditiis sit atque asperiores voluptatem. Officiis architecto ut cum laudantium quasi rerum.",
                "delay": {
                  "days": 105,
                  "offset_from_midnight": 85272
                },
                "template_id": 2,
                "subject": "Repellendus ut voluptas accusamus neque sit.",
                "content": "Alias similique cupiditate odit molestiae impedit non autem. Ab perspiciatis sint sit. Facere porro deleniti non architecto ea ut minus. Ut maiores aperiam error ipsa animi voluptas ducimus."
              }
            ],
            "created_at": "2017-04-19 19:39:47",
            "updated_at": "2017-04-30 02:59:47"
          }
        ],
        "chance_of_success": 100
      },
      {
        "id": "943cef92-f9b4-4fcb-b4e4-834f34915973",
        "name": "Some other milestone",
        "sort_order": 2,
        "set_status": "open",
        "suggest_task_after": 172800,
        "jumpoff": null,
        "milestone_types": [],
        "content_suggestions": [
          {
            "id": "5d0a2b97-cec8-4e77-bb32-624ed9e6edc9",
            "type": "email",
            "name": "cupiditate",
            "subject": "molestiae",
            "content": "Alias similique cupiditate odit molestiae impedit non autem. Ab perspiciatis sint sit. Facere porro deleniti non architecto ea ut minus. Ut maiores aperiam error ipsa animi voluptas ducimus.",
            "templates": [
              {
                "id": 1,
                "type": "letter",
                "company_id": 1,
                "title": "Letter template",
                "user_id": 1,
                "team_id": null,
                "group_id": null,
                "campaign": false
              }
            ]
          }
        ],
        "extra_step": [
          {
            "id": "de4bb6f0-b5f4-4a7d-940d-dbeef24e3ac0",
            "sort_order": 1,
            "name": "Bring coffe"
          },
          {
            "id": "c8c7c9d3-8f6b-4e35-9fad-726f1918cd8d",
            "sort_order": 2,
            "name": "Call client"
          },
          {
            "id": "c05440df-15e5-4d29-910a-a8f5d598f0d9",
            "sort_order": 3,
            "name": "Decline this"
          }
        ],
        "additional_steps": null,
        "automated_communication": {
          "id": "fc52c6e5-4bc9-4773-95fd-d849331e8dcf",
          "team_id": 1,
          "name": "The.",
          "description": "molestiae.",
          "icon": "Gryphon.",
          "communications": [
            {
              "name": "Voluptatum ut omnis odio ab enim. Enim rerum eos officiis a aut velit placeat. Dolores facere voluptas quo dolores. Pariatur eius ex illo repudiandae qui velit eos et.",
              "delay": {
                "days": 59,
                "offset_from_midnight": 27164
              },
              "template_id": 2,
              "subject": "Omnis iure amet sequi iure libero.",
              "content": "Et reiciendis ex nemo. Explicabo nostrum rerum ut aut. In repellat sit porro nisi est voluptate sed. Totam omnis ipsa aut sint officia facere magnam."
            },
            {
              "name": "Dolores et ducimus consequatur accusamus. Est tempora aspernatur maxime explicabo quos. Pariatur ut doloremque fugiat quia et earum cupiditate.",
              "delay": {
                "days": 86,
                "offset_from_midnight": 34197
              },
              "template_id": 2,
              "subject": "Debitis culpa libero tempore.",
              "content": "Porro optio dolorum reprehenderit. Ut modi numquam aut et repellat nihil minus.\nSed fugit numquam ut totam maxime. Doloremque omnis provident voluptate dolor. Veritatis fuga magni minima."
            },
            {
              "name": "Doloremque est ad voluptas cumque. Quis fugiat non aut ullam autem illo. Ut aliquid natus exercitationem est. Nulla sit veritatis pariatur non.",
              "delay": {
                "days": 43,
                "offset_from_midnight": 21066
              },
              "template_id": 2,
              "subject": "Et similique a eos esse vitae nemo.",
              "content": "Aut sint esse quo nostrum et eius. Et officiis pariatur sit dolor in.\nSunt et ut aperiam unde. Tempore ut error nam dolorum harum blanditiis iste. Illo possimus consequuntur necessitatibus veritatis rerum alias aut amet. Qui atque consequuntur ex ut ad minima rerum. Natus officiis aliquid et."
            },
            {
              "name": "Facere quia doloribus illo possimus odio. Voluptatibus praesentium voluptatibus ratione eius. Esse qui corporis nostrum et unde inventore nam.",
              "delay": {
                "days": 59,
                "offset_from_midnight": 64029
              },
              "template_id": 2,
              "subject": "Quia doloribus ut facere incidunt.",
              "content": "Consequuntur molestias ex nam non. Quam nihil ex cum nulla iusto recusandae exercitationem assumenda. Minima iure esse ut quo sint. Numquam fugit ducimus aut nihil quis modi maiores.\nSit sit quidem voluptatibus odit laborum. Consequatur ex in et et. Eos in cumque incidunt."
            },
            {
              "name": "Error labore quod earum aut nesciunt. Dolor sed nam asperiores asperiores accusamus et. Laboriosam deserunt quae odio sint dolores.",
              "delay": {
                "days": 100,
                "offset_from_midnight": 70001
              },
              "template_id": 2,
              "subject": "Optio corporis nisi maiores optio ducimus.",
              "content": "Qui dolor ipsa quasi. Fugit non optio nobis et ut ut. Doloremque eveniet soluta non.\nVoluptatum qui doloremque enim rem ad. Quia est cupiditate necessitatibus qui molestiae. Rerum veritatis expedita molestias voluptatem officiis."
            }
          ],
          "created_at": "1997-06-17 08:51:27",
          "updated_at": "2001-01-04 16:28:29"
        },
        "chance_of_success": 30
      }
    ],
    "supportive": [
      {
        "id": "f4aaf74a-59c6-409b-8990-54b78eae1c75",
        "name": "Supportive",
        "sort_order": 2,
        "set_status": "open",
        "suggest_task_after": 172800,
        "content_suggestions": [
          {
            "id": "fe7f4d0f-3b56-4a28-bc6e-3f7648ac52fb",
            "type": "email",
            "name": "molestiae",
            "subject": "Nunc ullamcorper imperdiet sollicitudin. Mauris rutrum iaculis pretium. ",
            "content": "Nam lacinia malesuada tellus, nec vestibulum est luctus vitae. Donec ultricies turpis ut cursus semper. Sed at nibh orci. Suspendisse sit amet sem tristique, imperdiet ante vel, blandit tortor.",
            "templates": [
              {
                "id": 1,
                "type": "letter",
                "company_id": 1,
                "title": "Letter template",
                "user_id": 1,
                "team_id": null,
                "group_id": null,
                "campaign": false
              }
            ]
          },
          {
            "id": "b20c7a34-3821-47b5-a70c-f6a649b410ca",
            "name": "etiam",
            "subject": "Mauris quis lectus libero",
            "content": "Mauris porta ante ut urna dapibus fermentum. Quisque et tortor eros. Vivamus ac tortor tortor",
            "templates": null
          }
        ],
        "extra_step": [
          {
            "id": "86247236-dc8f-4d4c-b406-fed9d7db97c3",
            "sort_order": 1,
            "name": "Bring coffe"
          },
          {
            "id": "bd41fe6b-49c0-4ac1-987a-65c0a8ff238a",
            "sort_order": 2,
            "name": "Cancel meeting"
          },
          {
            "id": "3b71a00f-adca-43e2-8d2b-99e3a2d4e572",
            "sort_order": 3,
            "name": "Lunch"
          }
        ],
        "additional_steps": null,
        "automated_communication": {
          "id": "fc52c6e5-4bc9-4773-95fd-d849331e8dcf",
          "team_id": 1,
          "name": "The.",
          "description": "nobody spoke for some reason.",
          "icon": "Gryphon.",
          "communications": [
            {
              "name": "Voluptatum ut omnis odio ab enim. Enim rerum eos officiis a aut velit placeat. Dolores facere voluptas quo dolores. Pariatur eius ex illo repudiandae qui velit eos et.",
              "delay": {
                "days": 59,
                "offset_from_midnight": 27164
              },
              "template_id": 2,
              "subject": "Omnis iure amet sequi iure libero.",
              "content": "Et reiciendis ex nemo. Explicabo nostrum rerum ut aut. In repellat sit porro nisi est voluptate sed. Totam omnis ipsa aut sint officia facere magnam."
            },
            {
              "name": "Dolores et ducimus consequatur accusamus. Est tempora aspernatur maxime explicabo quos. Pariatur ut doloremque fugiat quia et earum cupiditate.",
              "delay": {
                "days": 86,
                "offset_from_midnight": 34197
              },
              "template_id": 2,
              "subject": "Debitis culpa libero tempore.",
              "content": "Porro optio dolorum reprehenderit. Ut modi numquam aut et repellat nihil minus.\nSed fugit numquam ut totam maxime. Doloremque omnis provident voluptate dolor. Veritatis fuga magni minima."
            },
            {
              "name": "Doloremque est ad voluptas cumque. Quis fugiat non aut ullam autem illo. Ut aliquid natus exercitationem est. Nulla sit veritatis pariatur non.",
              "delay": {
                "days": 43,
                "offset_from_midnight": 21066
              },
              "template_id": 2,
              "subject": "Et similique a eos esse vitae nemo.",
              "content": "Aut sint esse quo nostrum et eius. Et officiis pariatur sit dolor in.\nSunt et ut aperiam unde. Tempore ut error nam dolorum harum blanditiis iste. Illo possimus consequuntur necessitatibus veritatis rerum alias aut amet. Qui atque consequuntur ex ut ad minima rerum. Natus officiis aliquid et."
            },
            {
              "name": "Facere quia doloribus illo possimus odio. Voluptatibus praesentium voluptatibus ratione eius. Esse qui corporis nostrum et unde inventore nam.",
              "delay": {
                "days": 59,
                "offset_from_midnight": 64029
              },
              "template_id": 2,
              "subject": "Quia doloribus ut facere incidunt.",
              "content": "Consequuntur molestias ex nam non. Quam nihil ex cum nulla iusto recusandae exercitationem assumenda. Minima iure esse ut quo sint. Numquam fugit ducimus aut nihil quis modi maiores.\nSit sit quidem voluptatibus odit laborum. Consequatur ex in et et. Eos in cumque incidunt."
            },
            {
              "name": "Error labore quod earum aut nesciunt. Dolor sed nam asperiores asperiores accusamus et. Laboriosam deserunt quae odio sint dolores.",
              "delay": {
                "days": 100,
                "offset_from_midnight": 70001
              },
              "template_id": 2,
              "subject": "Optio corporis nisi maiores optio ducimus.",
              "content": "Qui dolor ipsa quasi. Fugit non optio nobis et ut ut. Doloremque eveniet soluta non.\nVoluptatum qui doloremque enim rem ad. Quia est cupiditate necessitatibus qui molestiae. Rerum veritatis expedita molestias voluptatem officiis."
            }
          ],
          "created_at": "1997-06-17 08:51:27",
          "updated_at": "2001-01-04 16:28:29"
        }
      },
      {
        "id": "f4aaf74a-409b-59c6-4a28-54b78eae1c75",
        "name": "Supportive",
        "sort_order": 3,
        "set_status": "declined",
        "suggest_task_after": 172800,
        "content_suggestions": [],
        "extra_step": [
          {
            "id": "86247236-4d4c-b406-dc8f-fed9d7db97c3",
            "sort_order": 1,
            "name": "Declined because of something"
          },
          {
            "id": "3441fe6b-4ac1-49c0-987a-65c0a8ff238a",
            "sort_order": 2,
            "name": "Declined because of something other"
          },
          {
            "id": "3b71a00f-8d2b-43e2-adca-99e3a2d4e572",
            "sort_order": 3,
            "name": "Bah"
          }
        ],
        "additional_steps": null,
        "automated_communication": {
          "id": "fc52c6e5-4bc9-4773-95fd-d849331e8dcf",
          "team_id": 1,
          "name": "The.",
          "description": "I got up and down, and nobody spoke for some.",
          "icon": "Gryphon.",
          "communications": [
            {
              "name": "Voluptatum ut omnis odio ab enim. Enim rerum eos officiis a aut velit placeat. Dolores facere voluptas quo dolores. Pariatur eius ex illo repudiandae qui velit eos et.",
              "delay": {
                "days": 59,
                "offset_from_midnight": 27164
              },
              "template_id": 2,
              "subject": "Omnis iure amet sequi iure libero.",
              "content": "Et reiciendis ex nemo. Explicabo nostrum rerum ut aut. In repellat sit porro nisi est voluptate sed. Totam omnis ipsa aut sint officia facere magnam."
            },
            {
              "name": "Dolores et ducimus consequatur accusamus. Est tempora aspernatur maxime explicabo quos. Pariatur ut doloremque fugiat quia et earum cupiditate.",
              "delay": {
                "days": 86,
                "offset_from_midnight": 34197
              },
              "template_id": 2,
              "subject": "Debitis culpa libero tempore.",
              "content": "Porro optio dolorum reprehenderit. Ut modi numquam aut et repellat nihil minus.\nSed fugit numquam ut totam maxime. Doloremque omnis provident voluptate dolor. Veritatis fuga magni minima."
            },
            {
              "name": "Doloremque est ad voluptas cumque. Quis fugiat non aut ullam autem illo. Ut aliquid natus exercitationem est. Nulla sit veritatis pariatur non.",
              "delay": {
                "days": 43,
                "offset_from_midnight": 21066
              },
              "template_id": 2,
              "subject": "Et similique a eos esse vitae nemo.",
              "content": "Aut sint esse quo nostrum et eius. Et officiis pariatur sit dolor in.\nSunt et ut aperiam unde. Tempore ut error nam dolorum harum blanditiis iste. Illo possimus consequuntur necessitatibus veritatis rerum alias aut amet. Qui atque consequuntur ex ut ad minima rerum. Natus officiis aliquid et."
            },
            {
              "name": "Facere quia doloribus illo possimus odio. Voluptatibus praesentium voluptatibus ratione eius. Esse qui corporis nostrum et unde inventore nam.",
              "delay": {
                "days": 59,
                "offset_from_midnight": 64029
              },
              "template_id": 2,
              "subject": "Quia doloribus ut facere incidunt.",
              "content": "Consequuntur molestias ex nam non. Quam nihil ex cum nulla iusto recusandae exercitationem assumenda. Minima iure esse ut quo sint. Numquam fugit ducimus aut nihil quis modi maiores.\nSit sit quidem voluptatibus odit laborum. Consequatur ex in et et. Eos in cumque incidunt."
            },
            {
              "name": "Error labore quod earum aut nesciunt. Dolor sed nam asperiores asperiores accusamus et. Laboriosam deserunt quae odio sint dolores.",
              "delay": {
                "days": 100,
                "offset_from_midnight": 70001
              },
              "template_id": 2,
              "subject": "Optio corporis nisi maiores optio ducimus.",
              "content": "Qui dolor ipsa quasi. Fugit non optio nobis et ut ut. Doloremque eveniet soluta non.\nVoluptatum qui doloremque enim rem ad. Quia est cupiditate necessitatibus qui molestiae. Rerum veritatis expedita molestias voluptatem officiis."
            }
          ],
          "created_at": "1997-06-17 08:51:27",
          "updated_at": "2001-01-04 16:28:29"
        }
      }
    ]
  },
  "default_template": {
    "email": null,
    "letter": null
  },
  "team_id": null,
  "created_at": "2015-03-04 11:51:19",
  "updated_at": "2015-03-04 11:51:19"
}

Create a relations path

POST /relations-paths

Parameters

  • name string
    • Required
  • is_sales_type boolean
    • Required
  • activity_types.milestones array
    • Required if activity_types.supportive is not present
    • activity_types.milestones.*.name string
      • Required
    • activity_types.milestones.*.chance_of_success integer
      • Between 0 and 100.
      • Required if is_sales_type is true
    • activity_types.milestones.*.sort_order integer
      • Required
    • activity_types.milestones.*.set_status string
      • One of the following: open or closed
      • Required
    • activity_types.milestones.*.suggest_task_after integer - Format is in seconds.
    • activity_types.milestones.*.milestone_types array
      • activity_types.milestones.*.milestone_types.* string
        • One of the following: test_drive, offer or need_analysis
    • activity_types.milestones.*.automated_communications array
      • activity_types.milestones.*.automated_communications.* UUID
    • activity_types.milestones.*.content_suggestions array
      • activity_types.milestones.*.content_suggestions.*.name string
        • Required
      • activity_types.milestones.*.content_suggestions.*.type string
        • One of the following: letter or email
        • Required
      • activity_types.milestones.*.content_suggestions.*.subject string
      • activity_types.milestones.*.content_suggestions.*.content string
        • Required
      • activity_types.milestones.*.content_suggestions.*.template_ids array
    • activity_types.milestones.*.extra_step array
      • activity_types.milestones.*.extra_step.*.name string
        • Required
      • activity_types.milestones.*.extra_step.*.sort_order integer
        • Required
    • activity_types.milestones.*.additional_steps array
      • Can be product_details, correspondence, automations, plan_next_step
  • activity_types.supportive array
    • Required if activity_types.milestones is not present
    • activity_types.supportive.*.name string
      • Required
    • activity_types.supportive.*.sort_order integer
      • Required
    • activity_types.supportive.*.set_status string
      • One of the following: open or declined
      • Required
    • activity_types.supportive.*.suggest_task_after integer - Format is in seconds.
    • activity_types.supportive.*.automated_communications array
      • activity_types.supportive.*.automated_communications.* UUID
    • activity_types.supportive.*.content_suggestions array
      • activity_types.supportive.*.content_suggestions.*.name string
        • Required
      • activity_types.supportive.*.content_suggestions.*.type string
        • One of the following: letter or email.
        • Required
      • activity_types.supportive.*.content_suggestions.*.subject string
      • activity_types.supportive.*.content_suggestions.*.content string
        • Required
      • activity_types.supportive.*.content_suggestions.*.template_ids array
        • activity_types.supportive.*.content_suggestions.*.template_ids.* integer
    • activity_types.supportive.*.extra_step array
      • activity_types.supportive.*.extra_step.*.name string
        • Required
      • activity_types.supportive.*.extra_step.*.sort_order integer
        • Required
    • activity_types.supportive.*.additional_steps array
      • Can be product_details, correspondence, automations, plan_next_step
  • default_template object
  • default_template.email int. Valid template id of type email
  • default_template.letter int. Valid template id of type letter

Payload

{
  "name": "Regular sales",
  "is_sales_type": true,
  "activity_types": {
    "milestones": [
      {
        "name": "Initial Contact",
        "sort_order": 1,
        "set_status": "open",
        "chance_of_success": 100,
        "suggest_task_after": 172800,
        "milestone_types": [],
        "content_suggestions": [
          {
            "type": "email",
            "name": "Initial customer e-mail",
            "subject": "Thank you for contacting us",
            "content": "Thanks for reaching out to us.\nWe'll be contacting you shortly.",
            "template_ids": [1]
          }
        ]
      },
      {
        "name": "Sales process",
        "sort_order": 2,
        "set_status": "open",
        "chance_of_success": 80,
        "suggest_task_after": 172800,
        "milestone_types": [],
        "automated_communications": null,
        "content_suggestions": [
          {
            "type": "email",
            "name": "Interested in sale",
            "subject": "Here's your offer",
            "content": "We have compiled an offer for you, please see the attached file for the full overview.",
            "template_ids": [1]
          },
          {
            "type": "email",
            "name": "Response to questions",
            "subject": "Questions and answers",
            "content": "Here follows a list of questions and answers that might be relevant to your situation...",
            "template_ids": [1]
          },
          {
            "type": "email",
            "name": "Invoice",
            "subject": "Invoice for order ID #",
            "content": "Please find attached the invoice for your order ID #",
            "template_ids": [1]
          }
        ],
        "extra_step": [
          {
            "sort_order": 1,
            "name": "Do inventory lookup"
          },
          {
            "sort_order": 2,
            "name": "Create need analysis"
          },
          {
            "sort_order": 3,
            "name": "Create offer"
          },
          {
            "sort_order": 4,
            "name": "Create invoice"
          }
        ]
      },
      {
        "name": "Aftersales",
        "sort_order": 2,
        "set_status": "open",
        "chance_of_success": 80,
        "suggest_task_after": 172800,
        "milestone_types": [],
        "automated_communications": [
            "38d92091-4a86-41da-8e6f-ae55aaddfe9f"
        ],
        "content_suggestions": [
          {
            "type": "email",
            "name": "Is there anything we can do?",
            "subject": "Is there anything we can do?",
            "content": "Hi, just checking in on you. It's been a few weeks, and we're wondering if everything is as it should be. Please reach out to us if you have any questions or issues!",
            "template_ids": [1]
          }
        ],
        "extra_step": [
          {
            "sort_order": 1,
            "name": "Do inventory lookup"
          },
          {
            "sort_order": 2,
            "name": "Create need analysis"
          },
          {
            "sort_order": 3,
            "name": "Create offer"
          }
        ]
      }
    ],
    "supportive": [
      {
        "name": "No sale",
        "sort_order": 2,
        "set_status": "declined",
        "suggest_task_after": 172800,
        "content_suggestions": [
          {
            "type": "email",
            "name": "Sale did not succeed",
            "subject": "See you next time!",
            "content": "We're sad to see that it didn't work out, but we hope we might be able to help you another time!"
          }
        ],
        "extra_step": [
          {
            "sort_order": 1,
            "name": "Mark offer as inactive"
          }
        ]
      }
    ]
  }
}

Response
Status code 201

{
  "id": "e7a2ae35-55bc-4116-aa70-bbd8969abe5e",
  "name": "Regular sales",
  "is_sales_type": true,
  "activity_types": {
    "milestones": [
      {
        "id": "b7ef117b-f26f-4a55-8902-b40e7a924bbf",
        "name": "Initial Contact",
        "sort_order": 1,
        "set_status": "open",
        "suggest_task_after": 172800,
        "jumpoff": null,
        "milestone_types": [],
        "template_id": null,
        "content_suggestions": [
          {
            "id": "9e943f08-99b9-46d6-b4eb-ae5048ef48c5",
            "type": "email",
            "name": "Initial customer e-mail",
            "subject": "Thank you for contacting us",
            "content": "Thanks for reaching out to us.\nWe'll be contacting you shortly.",
            "template_ids": [1],
            "team_id": null
          }
        ],
        "extra_step": null,
        "additional_steps": null,
        "automated_communications": null,
        "chance_of_success": 100
      },
      {
        "id": "97b1538b-c90f-4bb3-a1fa-3af917e7746a",
        "name": "Sales process",
        "sort_order": 2,
        "set_status": "open",
        "suggest_task_after": 172800,
        "jumpoff": null,
        "milestone_types": [],
        "template_id": null,
        "content_suggestions": [
          {
            "id": "7d013a64-c8b2-44b4-9c52-500093ffb499",
            "type": "email",
            "name": "Interested in sale",
            "subject": "Here's your offer",
            "content": "We have compiled an offer for you, please see the attached file for the full overview.",
            "template_ids": [1],
            "team_id": null
          },
          {
            "id": "a833b91c-d80e-46d6-8eb4-d8cd62ecf69c",
            "type": "email",
            "name": "Response to questions",
            "subject": "Questions and answers",
            "content": "Here follows a list of questions and answers that might be relevant to your situation...",
            "template_ids": [1],
            "team_id": null
          },
          {
            "id": "9e95d346-9fb5-46e7-bc6b-5e2c07f95afa",
            "type": "email",
            "name": "Invoice",
            "subject": "Invoice for order ID #",
            "content": "Please find attached the invoice for your order ID #",
            "template_ids": [1],
            "team_id": null
          }
        ],
        "extra_step": [
          {
            "id": "b70bed67-9909-415b-8881-8fd3b80e0d03",
            "sort_order": 1,
            "name": "Do inventory lookup"
          },
          {
            "id": "68dbc3c4-f4ce-4365-ad6d-3c3bee0443ae",
            "sort_order": 2,
            "name": "Create need analysis"
          },
          {
            "id": "ad2d702c-e85e-43d0-9288-b6c41743a01c",
            "sort_order": 3,
            "name": "Create offer"
          },
          {
            "id": "5b0d4975-4890-42c6-a4a7-d1bf2d337df4",
            "sort_order": 4,
            "name": "Create invoice"
          }
        ],
        "additional_steps": null,
        "automated_communications": null,
        "chance_of_success": 80
      },
      {
        "id": "8d503430-3de1-45c9-8b8f-a98ad11d577d",
        "name": "Aftersales",
        "sort_order": 2,
        "set_status": "open",
        "suggest_task_after": 172800,
        "jumpoff": null,
        "milestone_types": [],
        "template_id": null,
        "content_suggestions": [
          {
            "id": "bac19efd-044d-4bd8-aa04-269a26f7daca",
            "type": "email",
            "name": "Is there anything we can do?",
            "subject": "Is there anything we can do?",
            "content": "Hi, just checking in on you. It's been a few weeks, and we're wondering if everything is as it should be. Please reach out to us if you have any questions or issues!",
            "template_ids": [1],
            "team_id": null
          }
        ],
        "extra_step": [
          {
            "id": "3991dac0-f1aa-4577-86b4-bc60005de089",
            "sort_order": 1,
            "name": "Do inventory lookup"
          },
          {
            "id": "279a22c9-7244-4271-afa2-935b0de532cb",
            "sort_order": 2,
            "name": "Create need analysis"
          },
          {
            "id": "e00cd0bb-efed-43e8-90fe-0408346a0f9b",
            "sort_order": 3,
            "name": "Create offer"
          }
        ],
        "additional_steps": null,
        "automated_communications": null,
        "chance_of_success": 80
      }
    ],
    "supportive": [
      {
        "id": "d7f61d44-0dba-4fa5-89a2-baf1407dd837",
        "name": "No sale",
        "sort_order": 2,
        "set_status": "declined",
        "suggest_task_after": 172800,
        "template_id": null,
        "content_suggestions": [
          {
            "id": "4df942b8-1c90-4451-9f11-7a32a12a8ac9",
            "type": "email",
            "name": "Sale did not succeed",
            "subject": "See you next time!",
            "content": "We're sad to see that it didn't work out, but we hope we might be able to help you another time!",
            "template_ids": null,
            "team_id": null
          }
        ],
        "extra_step": [
          {
            "id": "a53014cf-07bf-483c-a16c-031cba14c87a",
            "sort_order": 1,
            "name": "Mark offer as inactive"
          }
        ],
        "additional_steps": null,
        "automated_communications": null
      }
    ]
  },
  "default_template": {
    "email": null,
    "letter": null
  },
  "team_id": null,
  "group_id": null,
  "created_at": "2016-05-15 06:57:27",
  "updated_at": "2016-05-15 06:57:27"
}

Update a relations path

PUT /relations-paths/:relations_path_id

Parameters

  • Uses same parameters as Create relations path
  • activity_types.milestones.*.id UUID
    • activity_types.milestones.*.content_suggestions.*.id UUID
    • activity_types.milestones.*.extra_step.*.id UUID
  • activity_types.supportive.*.id UUID
    • activity_types.supportive.*.content_suggestions.*.id UUID
    • activity_types.supportive.*.extra_step.*.id UUID

Payload

{
  "name": "Regular sales",
  "is_sales_type": true,
  "activity_types": {
    "milestones": [
      {
        "id": "fa1047c1-0b10-4818-b122-0e2e09696088",
        "name": "Initial Contact",
        "sort_order": 1,
        "set_status": "open",
        "chance_of_success": 100,
        "suggest_task_after": 172800,
        "milestone_types": [],
        "content_suggestions": [
          {
            "id": "be081213-6b6c-4728-b9f8-4de5dbb50294",
            "type": "email",
            "name": "Initial customer e-mail",
            "subject": "Thank you for contacting us",
            "content": "Thanks for reaching out to us.\nWe'll be contacting you shortly.",
            "template_ids": [
              1,
              2
            ]
          }
        ]
      },
      {
        "id": "964b3016-c710-4559-9810-ffcee97a3c45",
        "name": "Sales process",
        "sort_order": 2,
        "set_status": "open",
        "chance_of_success": 80,
        "suggest_task_after": 172800,
        "milestone_types": [],
        "content_suggestions": [
          {
            "id": "be081213-6b6c-4728-b9f8-4de5dbb50294",
            "type": "email",
            "name": "Interested in sale",
            "subject": "Here's your offer",
            "content": "We have compiled an offer for you, please see the attached file for the full overview.",
            "template_ids": [
              1,
              2
            ]
          },
          {
            "type": "email",
            "name": "Response to questions",
            "subject": "Questions and answers",
            "content": "Here follows a list of questions and answers that might be relevant to your situation...",
            "template_ids": [
              1,
              2
            ]
          },
          {
            "type": "email",
            "name": "Invoice/Contract",
            "subject": "Invoice for order ID #",
            "content": "Please find attached the invoice for your order ID #",
            "template_ids": [
              1,
              2
            ]
          }
        ],
        "extra_step": [
          {
            "id": "5c9373be-badc-4dc3-ad45-b447540015d9",
            "sort_order": 1,
            "name": "Do inventory lookup"
          },
          {
            "id": "c35c716a-a20f-4255-aa07-dfb7e13137f4",
            "sort_order": 2,
            "name": "Create need analysis"
          },
          {
            "id": "f088dda1-42f3-49b8-a2df-7eda85ba23a1",
            "sort_order": 3,
            "name": "Create offer"
          }
        ]
      },
      {
        "name": "Aftersales",
        "sort_order": 2,
        "set_status": "open",
        "chance_of_success": 80,
        "suggest_task_after": 172800,
        "milestone_types": [],
        "content_suggestions": [
          {
            "type": "email",
            "name": "Is there anything we can do?",
            "subject": "Is there anything we can do?",
            "content": "Hi, just checking in on you. It's been a few weeks, and we're wondering if everything is as it should be. Please reach out to us if you have any questions or issues!",
            "template_ids": [
              1,
              2
            ]
          }
        ],
        "extra_step": [
          {
            "sort_order": 1,
            "name": "Do inventory lookup"
          },
          {
            "sort_order": 2,
            "name": "Create need analysis"
          },
          {
            "sort_order": 3,
            "name": "Create offer"
          }
        ]
      }
    ],
    "supportive": [
      {
        "id": "c258fcd1-c2b2-428f-9fe9-d3e9365f2c4f",
        "name": "No sale",
        "sort_order": 2,
        "set_status": "declined",
        "suggest_task_after": 172800,
        "automated_communication_id": "38d92091-4a86-41da-8e6f-ae55aaddfe9f",
        "content_suggestions": [
          {
            "id": "8157982a-a931-4ef5-bf16-5274bff9e6c0",
            "type": "email",
            "name": "Sale did not succeed",
            "subject": "See you next time!",
            "content": "We're sad to see that it didn't work out, but we hope we might be able to help you another time!"
          }
        ],
        "extra_step": [
          {
            "id": "7557ada4-9bb5-4e0e-8857-590effc8d5fd",
            "sort_order": 1,
            "name": "Mark offer as inactive"
          }
        ]
      }
    ]
  }
}

Response
Status code 200

{
  "id": "e7a2ae35-55bc-4116-aa70-bbd8969abe5e",
  "name": "Regular sales",
  "is_sales_type": true,
  "activity_types": {
    "milestones": [
      {
        "id": "fa1047c1-0b10-4818-b122-0e2e09696088",
        "name": "Initial Contact",
        "sort_order": 1,
        "set_status": "open",
        "suggest_task_after": 172800,
        "jumpoff": null,
        "milestone_types": [],
        "template_id": null,
        "content_suggestions": [
          {
            "id": "be081213-6b6c-4728-b9f8-4de5dbb50294",
            "type": "email",
            "name": "Initial customer e-mail",
            "subject": "Thank you for contacting us",
            "content": "Thanks for reaching out to us.\nWe'll be contacting you shortly.",
            "template_ids": [
              1,
              2
            ],
            "team_id": null
          }
        ],
        "extra_step": null,
        "additional_steps": null,
        "automated_communications": null,
        "chance_of_success": 100
      },
      {
        "id": "964b3016-c710-4559-9810-ffcee97a3c45",
        "name": "Sales process",
        "sort_order": 2,
        "set_status": "open",
        "suggest_task_after": 172800,
        "jumpoff": null,
        "milestone_types": [],
        "template_id": null,
        "content_suggestions": [
          {
            "id": "9097f427-e3d4-4c2b-be2e-d01bc271affe",
            "type": "email",
            "name": "Interested in sale",
            "subject": "Here's your offer",
            "content": "We have compiled an offer for you, please see the attached file for the full overview.",
            "template_ids": [
              1,
              2
            ],
            "team_id": null
          },
          {
            "id": "55a4a62b-6c48-4700-9f9a-2186cd8d4ff2",
            "type": "email",
            "name": "Response to questions",
            "subject": "Questions and answers",
            "content": "Here follows a list of questions and answers that might be relevant to your situation...",
            "template_ids": [
              1,
              2
            ],
            "team_id": null
          },
          {
            "id": "d24b0b46-6a05-4ca4-83cf-8157a42f8882",
            "type": "email",
            "name": "Invoice/Contract",
            "subject": "Invoice for order ID #",
            "content": "Please find attached the invoice for your order ID #",
            "template_ids": [
              1,
              2
            ],
            "team_id": null
          }
        ],
        "extra_step": [
          {
            "id": "0c483707-d838-4fd5-8777-428daeefa785",
            "sort_order": 1,
            "name": "Do inventory lookup"
          },
          {
            "id": "4af3a1d5-72ab-4d3a-84da-9014c81c4a9b",
            "sort_order": 2,
            "name": "Create need analysis"
          },
          {
            "id": "ef61056b-f981-403d-90fc-7f335e1ceae7",
            "sort_order": 3,
            "name": "Create offer"
          },
          {
            "id": "cdba7f51-052a-4435-816d-36c3b6f35d9a",
            "sort_order": 4,
            "name": "Create invoice"
          }
        ],
        "additional_steps": null,
        "automated_communications": null,
        "chance_of_success": 80
      },
      {
        "id": "d1ac8201-77b4-402d-ad8e-8cf2981bdcfc",
        "name": "Aftersales",
        "sort_order": 2,
        "set_status": "open",
        "suggest_task_after": 172800,
        "jumpoff": null,
        "milestone_types": [],
        "template_id": null,
        "content_suggestions": [
          {
            "id": "239855d5-7e62-4df5-bd12-24e7b30361b5",
            "type": "email",
            "name": "Is there anything we can do?",
            "subject": "Is there anything we can do?",
            "content": "Hi, just checking in on you. It's been a few weeks, and we're wondering if everything is as it should be. Please reach out to us if you have any questions or issues!",
            "template_ids": [
              1
            ],
            "team_id": null
          }
        ],
        "extra_step": [
          {
            "id": "5c9373be-badc-4dc3-ad45-b447540015d9",
            "sort_order": 1,
            "name": "Do inventory lookup"
          },
          {
            "id": "c35c716a-a20f-4255-aa07-dfb7e13137f4",
            "sort_order": 2,
            "name": "Create need analysis"
          },
          {
            "id": "f088dda1-42f3-49b8-a2df-7eda85ba23a1",
            "sort_order": 3,
            "name": "Create offer"
          }
        ],
        "additional_steps": null,
        "automated_communications":null,
        "chance_of_success": 80
      }
    ],
    "supportive": [
      {
        "id": "c258fcd1-c2b2-428f-9fe9-d3e9365f2c4f",
        "name": "No sale",
        "sort_order": 2,
        "set_status": "declined",
        "suggest_task_after": 172800,
        "template_id": null,
        "content_suggestions": [
          {
            "id": "8157982a-a931-4ef5-bf16-5274bff9e6c0",
            "type": "email",
            "name": "Sale did not succeed",
            "subject": "See you next time!",
            "content": "We're sad to see that it didn't work out, but we hope we might be able to help you another time!",
            "template_ids": null,
            "team_id": null
          }
        ],
        "extra_step": [
          {
            "id": "7557ada4-9bb5-4e0e-8857-590effc8d5fd",
            "sort_order": 1,
            "name": "Mark offer as inactive"
          }
        ],
        "additional_steps": null,
        "automated_communications": null
      }
    ]
  },
  "default_template": {
    "email": null,
    "letter": null
  },
  "team_id": null,
  "created_at": "2016-05-15 06:57:27",
  "updated_at": "2016-05-15 06:57:27"
}

Delete a relations path

DELETE /relations-paths/relations_path_id

Response
Status code 204