Pinging the customer on this. Will follow up Friday.
\",\n \"replied_to_comment_uuid\": \"f29b2878-a1a4-4d93-a0fb-1e1e48930aac\"\n}" } } } ] }, { "name": "customers", "item": [ { "name": "Get all customers", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers" ], "query": [ { "key": "name", "value": "", "disabled": true, "description": "" }, { "key": "primary_email", "value": "", "disabled": true, "description": "" }, { "key": "tag_id", "value": "", "disabled": true, "description": "" }, { "key": "tag_uuid", "value": "", "disabled": true, "description": "" }, { "key": "is_archived", "value": "", "disabled": true, "description": "" } ], "variable": [] }, "description": "Use this route to get a list of all active customers for your organization. This route requires a valid API key." } }, { "name": "Create A New Customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers" ], "query": [], "variable": [] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"ACME Inc\",\n \"primary_email\": \"acme.inc@test.com\",\n \"physical_address\": \"123 Main St, Big City, USA\"\n}" } } }, { "name": "Get Customer By Id", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "" } }, { "name": "Update Customer By Id", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}" ], "query": [ { "key": "name", "value": "", "disabled": true, "description": "" }, { "key": "primary_email", "value": "", "disabled": true, "description": "" }, { "key": "physical_address", "value": "", "disabled": true, "description": "" } ], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Update a customer account." } }, { "name": "Archive A Customer Account", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "archive" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Archive a customer account." } }, { "name": "Set a data field value on a customer", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/datafields/{datafield_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "datafields", "{datafield_uuid}" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" }, { "key": "datafield_uuid", "value": "", "description": "Data field UUID" } ] }, "description": "Creates the value if it does not exist yet, otherwise updates it. `value` is required; pass `null` (or an empty string) to clear the value. The change is recorded in activity history and fires data field automation, including CRM field-sync.", "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}" } } }, { "name": "List a customer's external (CRM) links", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/external-links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "external-links" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Returns all external links (links to CRM/integration records) attached to the specified customer account." } }, { "name": "Link a CRM record to a customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/external-links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "external-links" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Attaches a link to an external CRM/integration record to the specified customer account.", "body": { "mode": "raw", "raw": "{\n \"integration_uuid\": \"f29b2878-a1a4-4d93-a0fb-1e1e48930aac\",\n \"external_id\": \"0061t00000abcAAA\",\n \"external_type\": \"Opportunity\",\n \"external_label\": \"Acme - New Business\",\n \"external_link\": \"https://na1.salesforce.com/0061t00000abcAAA\",\n \"additional_data\": {}\n}" } } }, { "name": "Update a customer's external link", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/external-links/{link_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "external-links", "{link_uuid}" ], "query": [], "variable": [ { "key": "link_uuid", "value": "", "description": "" }, { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Updates the label, deep link, or metadata of an external link. The linked record identity is immutable. This is a partial update: omitted fields are left unchanged, and fields cannot be cleared to null.", "body": { "mode": "raw", "raw": "{\n \"external_label\": \"Acme - Renamed\",\n \"external_link\": \"https://na1.salesforce.com/0061t00000abcAAA\",\n \"additional_data\": {}\n}" } } }, { "name": "Remove an external link from a customer", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/external-links/{link_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "external-links", "{link_uuid}" ], "query": [], "variable": [ { "key": "link_uuid", "value": "", "description": "" }, { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Detaches (archives) the external link from the customer account." } }, { "name": "List all notes for a customer", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/notes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "notes" ], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "" }, { "key": "offset", "value": "", "disabled": true, "description": "" } ], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Returns a paginated list of all notes associated with the specified customer. Notes are ordered by creation date (newest first)." } }, { "name": "Create a new note for a customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/notes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "notes" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Creates a new note associated with the specified customer. The content field accepts both plain text and HTML.", "body": { "mode": "raw", "raw": "{\n \"content\": \"This is a note with rich text formatting.
\",\n \"title\": \"Meeting Notes\",\n \"tag_uuids\": [\n \"f29b2878-a1a4-4d93-a0fb-1e1e48930aac\",\n \"a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6\"\n ]\n}" } } }, { "name": "Get a specific note", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/notes/{note_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "notes", "{note_id}" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" }, { "key": "note_id", "value": "", "description": "Note ID (integer) or Note UUID" } ] }, "description": "Returns a single note by its ID. The note must belong to the specified customer." } }, { "name": "Update a customer note", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/notes/{note_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "notes", "{note_id}" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" }, { "key": "note_id", "value": "", "description": "Note ID (integer) or Note UUID" } ] }, "description": "Updates an existing note. Only the creator of the note can update it.", "body": { "mode": "raw", "raw": "{\n \"content\": \"Updated note content.
\",\n \"title\": \"Updated Meeting Notes\"\n}" } } }, { "name": "Delete a customer note", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/notes/{note_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "notes", "{note_id}" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" }, { "key": "note_id", "value": "", "description": "Note ID (integer) or Note UUID" } ] }, "description": "Soft deletes a note. Only the creator of the note can delete it. Returns 204 No Content on success." } }, { "name": "List Customer Resources", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/resources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "resources" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "List the customer account's URL link attachments.\nRecords linked from a connected CRM or integration are a separate surface \u2014\nsee the customer's `/external_links` endpoints." } }, { "name": "Create Customer Resource", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/resources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "resources" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Attach an external URL link (document, video, etc.) to the customer account.\n`/resources` manages URL link attachments; to link a record from a connected\nCRM or integration, use the customer's `/external_links` endpoints instead.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Onboarding Docs\",\n \"url\": \"https://example.com/docs\",\n \"description\": \"Getting-started guide\",\n \"show_to_customer\": true,\n \"is_key\": false\n}" } } }, { "name": "Update Customer Resource", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/resources/{resource_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "resources", "{resource_uuid}" ], "query": [], "variable": [ { "key": "resource_uuid", "value": "", "description": "" }, { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Update a URL link attached to the customer account (partial update).\nApplies to `/resources` link attachments only; links to CRM/integration\nrecords are managed via the customer's `/external_links` endpoints.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Renamed Docs\",\n \"url\": \"https://example.com/new\",\n \"description\": \"Updated guide\",\n \"show_to_customer\": false,\n \"is_key\": true\n}" } } }, { "name": "Delete Customer Resource", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/resources/{resource_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "resources", "{resource_uuid}" ], "query": [], "variable": [ { "key": "resource_uuid", "value": "", "description": "" }, { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Detach a URL link from the customer account.\nApplies to `/resources` link attachments only; links to CRM/integration\nrecords are managed via the customer's `/external_links` endpoints." } }, { "name": "Add Tag To Customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/tag/{tag_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "tag", "{tag_id}" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" }, { "key": "tag_id", "value": "", "description": "Tag ID (integer) or Tag UUID" } ] }, "description": "" } }, { "name": "Remove Tag From Customer", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/tag/{tag_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "tag", "{tag_id}" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" }, { "key": "tag_id", "value": "", "description": "Tag ID (integer) or Tag UUID" } ] }, "description": "" } }, { "name": "Restore An Archived Customer Account", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "unarchive" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Restore an archived customer account. Symmetric counterpart to /archive." } }, { "name": "List a customer's portal contacts", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "users" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Returns a page of the customer's portal contacts (customer users) with their membership state. Detached contacts are included with active=false so directory-sync callers can see membership history, which is why the list is paged \u2014 use page and limit. Each entry also carries enabled, the contact's own state: a contact can hold an active membership while being disabled, and write operations addressing a disabled contact return 404." } }, { "name": "Create a portal contact under a customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "users" ], "query": [], "variable": [ { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Creates a new portal contact (customer user) and links it to the customer. No invitation email is sent by default; pass send_invite=true to email the contact a portal invitation. Without it, the portal invitation is delivered when the contact is added to a project. When an invite is requested, the response's invite_sent reports whether it was actually delivered and invite_status carries the reason when it was not \u2014 the contact is created either way.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Jordan\",\n \"last_name\": \"Rivera\",\n \"email_address\": \"jordan.rivera@acme.com\",\n \"phone_number\": \"(123) 456-7890\",\n \"job_title\": \"Procurement Lead\",\n \"send_invite\": false\n}" } } }, { "name": "Move an existing portal contact to this customer", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/customers/{customer_id}/users/{user_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", "{customer_id}", "users", "{user_uuid}" ], "query": [], "variable": [ { "key": "user_uuid", "value": "", "description": "" }, { "key": "customer_id", "value": "", "description": "Customer ID (integer) or Customer UUID" } ] }, "description": "Moves an existing portal contact to this customer. A portal contact belongs to exactly one customer, so this deactivates its previous customer link and revokes that customer's project access in the same operation. Reassigning a contact to the customer it is already on is a no-op success. Idempotent." } } ] }, { "name": "datafield-values", "item": [ { "name": "Bulk Update Datafield Values", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafield-values", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafield-values" ], "query": [], "variable": [] }, "description": "Bulk update DataField values\n\nUpdate multiple DataField values in a single request with best-effort processing.\nSuccessful updates persist even if other updates fail.\n\n**Side effects:** each write fires an activity-history entry and data field automation\n(including CRM field-sync), the same as a UI edit. The one exception: a value on an\nobject type mwa's forward does not yet support (org-vendor fields, and user / customer-\nuser / playbook fields) still writes directly and skips those side effect", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d\": \"New text value\",\n \"b2c3d4e5-f6a1-4a5b-8c9d-0e1f2a3b4c5d\": [\n \"Option A\",\n \"Option B\"\n ],\n \"f6e5d4c3-b2a1-4a5b-8c9d-0e1f2a3b4c5d\": \"2025-12-31\"\n },\n \"create_option_if_missing\": false,\n \"dry_run\": false\n}" } } }, { "name": "Get Datafield Value By Uuid", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafield-values/{datafield_value_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafield-values", "{datafield_value_uuid}" ], "query": [], "variable": [ { "key": "datafield_value_uuid", "value": "", "description": "UUID of the datafield value to retrieve" } ] }, "description": "Get a datafield value by UUID" } }, { "name": "Update Datafield Value", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafield-values/{datafield_value_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafield-values", "{datafield_value_uuid}" ], "query": [], "variable": [ { "key": "datafield_value_uuid", "value": "", "description": "UUID of the datafield value to update" } ] }, "description": "Update a datafield value by UUID\n\n**Side effects:** this write fires an activity-history entry and data field automation\n(including CRM field-sync), the same as a UI edit \u2014 the write is forwarded through\nmain-web-application's `upsert_from_api` for that. The one exception: a value on an\nobject type mwa's forward does not yet support (org-vendor fields, and user / customer-\nuser / playbook fields) still writes directly here and skips those side effects, exactly\nas this endpoint always has for eve", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"create_option_if_missing\": false\n}" } } }, { "name": "Delete Datafield Value", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafield-values/{datafield_value_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafield-values", "{datafield_value_uuid}" ], "query": [], "variable": [ { "key": "datafield_value_uuid", "value": "", "description": "UUID of the datafield value to delete" } ] }, "description": "Delete a datafield value by UUID.\n\nRemoves the value from its object. Returns 404 if no value with that UUID exists." } } ] }, { "name": "datafields", "item": [ { "name": "Get All Data Fields", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields" ], "query": [ { "key": "name", "value": "", "disabled": true, "description": "" }, { "key": "is_archived", "value": "", "disabled": true, "description": "" }, { "key": "is_required", "value": "", "disabled": true, "description": "" }, { "key": "object_type_code", "value": "", "disabled": true, "description": "" }, { "key": "type", "value": "", "disabled": true, "description": "" }, { "key": "apply_on_creation", "value": "", "disabled": true, "description": "" } ], "variable": [] }, "description": "" } }, { "name": "Create A Data Field", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields" ], "query": [], "variable": [] }, "description": "Create a data field.\n\n`permissions` sets the field's edit-permission list; omit or leave empty\nfor editable-by-all.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"object_type_code\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"is_required\": false,\n \"apply_on_creation\": false,\n \"default_value\": \"\",\n \"currency\": \"\",\n \"config\": {},\n \"permissions\": [\n \"\"\n ]\n}" } } }, { "name": "Get Data Field By Uuid", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields/{datafield_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields", "{datafield_uuid}" ], "query": [], "variable": [ { "key": "datafield_uuid", "value": "", "description": "" } ] }, "description": "" } }, { "name": "Update Data Field", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields/{datafield_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields", "{datafield_uuid}" ], "query": [], "variable": [ { "key": "datafield_uuid", "value": "", "description": "UUID of the datafield to update" } ] }, "description": "Update a data field's attributes.\n\nArchiving and unarchiving are not supported here \u2014 use\nPOST /v1/datafields/{datafield_uuid}/archive and /unarchive, which also\nupdate saved views referencing the field.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"default_value\": \"\",\n \"is_required\": false,\n \"apply_on_creation\": false,\n \"currency\": \"\"\n}" } } }, { "name": "Archive A Data Field", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields/{datafield_uuid}/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields", "{datafield_uuid}", "archive" ], "query": [], "variable": [ { "key": "datafield_uuid", "value": "", "description": "" } ] }, "description": "Archive a data field." } }, { "name": "List Data Field Options", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields/{datafield_uuid}/options", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields", "{datafield_uuid}", "options" ], "query": [], "variable": [ { "key": "datafield_uuid", "value": "", "description": "" } ] }, "description": "List a dropdown/multi_select data field's options.\n\nRead-only, served from the same Postgres (no main-web-app round trip). 404 for an\nunknown field; 400 for a field type that has no options." } }, { "name": "Create A Data Field Option", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields/{datafield_uuid}/options", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields", "{datafield_uuid}", "options" ], "query": [], "variable": [ { "key": "datafield_uuid", "value": "", "description": "" } ] }, "description": "Create an option on a dropdown/multi_select data field.\n\nForwards to main-web-app (the option write + its side-effects are single-homed there);\nthe created option in the upstream response becomes the payload.", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"color\": \"\"\n}" } } }, { "name": "Update A Data Field Option", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields/{datafield_uuid}/options/{option_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields", "{datafield_uuid}", "options", "{option_id}" ], "query": [], "variable": [ { "key": "datafield_uuid", "value": "", "description": "" }, { "key": "option_id", "value": "", "description": "" } ] }, "description": "Rename and/or recolor an option. A rename preserves existing assignments (rewritten upstream).", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"color\": \"\"\n}" } } }, { "name": "Remove A Data Field Option", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields/{datafield_uuid}/options/{option_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields", "{datafield_uuid}", "options", "{option_id}" ], "query": [], "variable": [ { "key": "datafield_uuid", "value": "", "description": "" }, { "key": "option_id", "value": "", "description": "" } ] }, "description": "Remove an option. Existing assignments keep their stored label; returns the remaining options.\n\nThe client's delete() yields only a status code, so the remaining options are read back from\nthe same Postgres after the upstream commit." } }, { "name": "Restore An Archived Data Field", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields/{datafield_uuid}/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields", "{datafield_uuid}", "unarchive" ], "query": [], "variable": [ { "key": "datafield_uuid", "value": "", "description": "" } ] }, "description": "Restore an archived data field. Symmetric counterpart to /archive." } }, { "name": "List Datafield Values For A Specific Datafield", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/datafields/{datafield_uuid}/values", "host": [ "{{baseUrl}}" ], "path": [ "v1", "datafields", "{datafield_uuid}", "values" ], "query": [], "variable": [ { "key": "datafield_uuid", "value": "", "description": "" } ] }, "description": "" } } ] }, { "name": "events", "item": [ { "name": "Get All Events", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/events", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events" ], "query": [ { "key": "name", "value": "", "disabled": true, "description": "" } ], "variable": [] }, "description": "" } } ] }, { "name": "library modules", "item": [ { "name": "List Library Modules", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/modules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "modules" ], "query": [ { "key": "name", "value": "", "disabled": true, "description": "" }, { "key": "is_archived", "value": "", "disabled": true, "description": "" } ], "variable": [] }, "description": "List your library modules \u2014 reusable module definitions that can be\nadded to playbooks. Filter by name or archived state." } }, { "name": "Create A Library Module", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/modules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "modules" ], "query": [], "variable": [] }, "description": "Create an empty library module.\n\nThe module is created with no tasks. Set additional attributes (portal\nname, work order) with PUT /v1/library/modules/{uuid}, and add tasks with\nPOST /v1/library/modules/{uuid}/tasks.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Onboarding\"\n}" } } }, { "name": "Get A Library Module By Uuid", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/modules/{library_module_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "modules", "{library_module_uuid}" ], "query": [], "variable": [ { "key": "library_module_uuid", "value": "", "description": "" } ] }, "description": "Fetch a single library module, including its tasks, tags, and data\nfield values." } }, { "name": "Update A Library Module", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/modules/{library_module_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "modules", "{library_module_uuid}" ], "query": [], "variable": [ { "key": "library_module_uuid", "value": "", "description": "" } ] }, "description": "Update a library module's editable fields (name, customer portal\nname, work order). Partial update \u2014 only fields present are applied.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Onboarding\",\n \"customer_portal_name\": \"Welcome\",\n \"work_order\": \"any_order\"\n}" } } }, { "name": "Archive A Library Module", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/modules/{library_module_uuid}/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "modules", "{library_module_uuid}", "archive" ], "query": [], "variable": [ { "key": "library_module_uuid", "value": "", "description": "" } ] }, "description": "Archive a library module.\n\nSoft archive only \u2014 the module is hidden from the library, never\nhard-deleted. A module still linked into one or more playbooks is\nrejected with 409; unlink it in the app first." } }, { "name": "Add A Task To A Library Module", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/modules/{library_module_uuid}/tasks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "modules", "{library_module_uuid}", "tasks" ], "query": [], "variable": [ { "key": "library_module_uuid", "value": "", "description": "UUID of the library module to add the task to" } ] }, "description": "Add a task to a library module.\n\nSend `name` + `type` to create a new task, or `library_task_uuid` to copy a\ntask (and its subtasks) from your task library \u2014 always an independent copy.\nChanges to a library module apply to every playbook that links it. Archived\nlibrary modules cannot be edited.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Kickoff call\",\n \"description\": \"\",\n \"type\": \"customer\",\n \"roles\": [\n \"\"\n ],\n \"duration\": 0,\n \"subtasks_must_be_completed_in_order\": false,\n \"is_description_shown\": false,\n \"library_task_uuid\": \"\"\n}" } } }, { "name": "Update A Library Module Task", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/modules/{library_module_uuid}/tasks/{task_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "modules", "{library_module_uuid}", "tasks", "{task_uuid}" ], "query": [], "variable": [ { "key": "library_module_uuid", "value": "", "description": "UUID of the library module the task belongs to" }, { "key": "task_uuid", "value": "", "description": "UUID of the task to update" } ] }, "description": "Update a task within a library module.\n\nPartial update \u2014 only the fields you send are changed: `name`, `description`\n(explicit null clears), `type`, `roles` (full replace-set), `duration`\n(explicit null clears), `subtasks_must_be_completed_in_order`,\n`is_description_shown`, `display_order` (position within the module).\nChanges apply to every playbook that links this library module. Archived\nlibrary modules cannot be edited.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"roles\": [\n \"\"\n ],\n \"duration\": 0,\n \"subtasks_must_be_completed_in_order\": false,\n \"is_description_shown\": false,\n \"display_order\": 0\n}" } } }, { "name": "Delete A Library Module Task", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/modules/{library_module_uuid}/tasks/{task_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "modules", "{library_module_uuid}", "tasks", "{task_uuid}" ], "query": [], "variable": [ { "key": "library_module_uuid", "value": "", "description": "UUID of the library module the task belongs to" }, { "key": "task_uuid", "value": "", "description": "UUID of the task to delete" } ] }, "description": "Delete a task from a library module.\n\nThe task's subtasks, dependencies, data field values, and tags are deleted\nwith it. The removal applies to every playbook that links this library\nmodule. Archived library modules cannot be edited." } }, { "name": "Restore An Archived Library Module", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/modules/{library_module_uuid}/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "modules", "{library_module_uuid}", "unarchive" ], "query": [], "variable": [ { "key": "library_module_uuid", "value": "", "description": "" } ] }, "description": "Restore an archived library module. Symmetric counterpart to /archive;\nnon-destructive. Already-active is a no-op." } } ] }, { "name": "library-tasks", "item": [ { "name": "List Library Tasks", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/tasks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "tasks" ], "query": [ { "key": "name", "value": "", "disabled": true, "description": "Filter by name (case-insensitive substring)" }, { "key": "tags", "value": "", "disabled": true, "description": "Filter by tag name; repeat for multiple (matches ANY)" }, { "key": "include_archived", "value": "", "disabled": true, "description": "Include archived library tasks" }, { "key": "limit", "value": "", "disabled": true, "description": "Max items to return (default 100, max 200)" }, { "key": "offset", "value": "", "disabled": true, "description": "Number of items to skip (pagination)" } ], "variable": [] }, "description": "List the caller's library tasks, filterable by name and tags. Paged\nvia `limit` (default 100, max 200) and `offset`." } }, { "name": "Create A Library Task", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/tasks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "tasks" ], "query": [], "variable": [] }, "description": "Create a library task. `name` is required; `duration` defaults to 1 day.\n\nNot idempotent: `name` is not unique, so repeating this call creates a\nduplicate. If a request times out, re-read (list/get) before retrying \u2014\nthe task may already have been created.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Kickoff call\",\n \"description\": \"Schedule and run the kickoff call\",\n \"duration\": 3,\n \"roles\": [\n 0\n ]\n}" } } }, { "name": "Get Library Task By Uuid", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/tasks/{task_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "tasks", "{task_uuid}" ], "query": [], "variable": [ { "key": "task_uuid", "value": "", "description": "" } ] }, "description": "Fetch a single library task by UUID." } }, { "name": "Update A Library Task", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/tasks/{task_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "tasks", "{task_uuid}" ], "query": [], "variable": [ { "key": "task_uuid", "value": "", "description": "" } ] }, "description": "Update mutable fields (name, description, duration, roles) of a\nlibrary task. Only fields present in the body are changed; an empty body\nis rejected upstream with a 400.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"duration\": 0,\n \"roles\": [\n 0\n ]\n}" } } }, { "name": "Archive A Library Task", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/tasks/{task_uuid}/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "tasks", "{task_uuid}", "archive" ], "query": [], "variable": [ { "key": "task_uuid", "value": "", "description": "" } ] }, "description": "Archive a library task (the library archives; there is no hard delete)." } }, { "name": "Restore An Archived Library Task", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/library/tasks/{task_uuid}/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "library", "tasks", "{task_uuid}", "unarchive" ], "query": [], "variable": [ { "key": "task_uuid", "value": "", "description": "" } ] }, "description": "Restore an archived library task. Symmetric counterpart to /archive." } } ] }, { "name": "modules", "item": [ { "name": "Get All Modules", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/modules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "modules" ], "query": [ { "key": "name", "value": "", "disabled": true, "description": "" }, { "key": "project_id", "value": "", "disabled": true, "description": "" }, { "key": "project_uuid", "value": "", "disabled": true, "description": "" }, { "key": "project_name", "value": "", "disabled": true, "description": "" }, { "key": "min_completed_percentage", "value": "", "disabled": true, "description": "" }, { "key": "max_completed_percentage", "value": "", "disabled": true, "description": "" } ], "variable": [] }, "description": "" } }, { "name": "Create A New Module", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/modules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "modules" ], "query": [], "variable": [] }, "description": "Create a new module on a project.", "body": { "mode": "raw", "raw": "{\n \"project_uuid\": \"f29b2878-a1a4-4d93-a0fb-1e1e48930aac\",\n \"name\": \"Onboarding\",\n \"display_order\": 3,\n \"customer_portal_name\": \"Welcome\"\n}" } } }, { "name": "Get Module By Id", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/modules/{module_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "modules", "{module_id}" ], "query": [], "variable": [ { "key": "module_id", "value": "", "description": "Module ID (integer) or Module UUID" } ] }, "description": "" } }, { "name": "Update Module By Id", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/modules/{module_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "modules", "{module_id}" ], "query": [], "variable": [ { "key": "module_id", "value": "", "description": "Module ID (integer) or Module UUID" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Module 1\",\n \"customer_portal_name\": \"Welcome Module\",\n \"work_order\": \"any_order\",\n \"display_order\": 3\n}" } } }, { "name": "Delete A Module", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/modules/{module_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "modules", "{module_id}" ], "query": [], "variable": [ { "key": "module_id", "value": "", "description": "Module ID (integer) or Module UUID" } ] }, "description": "Delete a project module.\n\nThe module must be empty (no tasks). If tasks remain, a 400 is\nreturned with the task count \u2014 delete the tasks first, then retry." } }, { "name": "Set a data field value on a module", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/modules/{module_id}/datafields/{datafield_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "modules", "{module_id}", "datafields", "{datafield_uuid}" ], "query": [], "variable": [ { "key": "module_id", "value": "", "description": "Module ID (integer) or Module UUID" }, { "key": "datafield_uuid", "value": "", "description": "Data field UUID" } ] }, "description": "Creates the value if it does not exist yet, otherwise updates it. `value` is required; pass `null` (or an empty string) to clear the value. The change is recorded in activity history and fires data field automation, including CRM field-sync.", "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}" } } }, { "name": "Save Module To Library", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/modules/{module_id}/save_to_library", "host": [ "{{baseUrl}}" ], "path": [ "v1", "modules", "{module_id}", "save_to_library" ], "query": [], "variable": [ { "key": "module_id", "value": "", "description": "Module ID (integer) or Module UUID" } ] }, "description": "Save a project module to your library.\n\nThe source module is left untouched. A new library module is created\nwith the source module's tasks, subtasks, dependencies, tags, and\ndata field values copied across. Send `name` in the body to set the\nlibrary module's name; defaults to the source module's name.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Onboarding Template\"\n}" } } }, { "name": "Add Tag To Module", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/modules/{module_id}/tag/{tag_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "modules", "{module_id}", "tag", "{tag_id}" ], "query": [], "variable": [ { "key": "module_id", "value": "", "description": "Module ID (integer) or Module UUID" }, { "key": "tag_id", "value": "", "description": "Tag ID (integer) or Tag UUID" } ] }, "description": "" } }, { "name": "Remove Tag From Module", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/modules/{module_id}/tag/{tag_id}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "modules", "{module_id}", "tag", "{tag_id}" ], "query": [], "variable": [ { "key": "module_id", "value": "", "description": "Module ID (integer) or Module UUID" }, { "key": "tag_id", "value": "", "description": "Tag ID (integer) or Tag UUID" } ] }, "description": "" } } ] }, { "name": "project_notes", "item": [ { "name": "Get Project Note", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/notes/{note_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notes", "{note_uuid}" ], "query": [], "variable": [ { "key": "note_uuid", "value": "", "description": "Project-note UUID (UUID only; legacy project notes use UUIDs on the public API)" } ] }, "description": "" } }, { "name": "Update Project Note", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/notes/{note_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notes", "{note_uuid}" ], "query": [], "variable": [ { "key": "note_uuid", "value": "", "description": "Project-note UUID (UUID only; legacy project notes use UUIDs on the public API)" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"note_detail\": \"\"\n}" } } }, { "name": "Delete Project Note", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/notes/{note_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notes", "{note_uuid}" ], "query": [], "variable": [ { "key": "note_uuid", "value": "", "description": "Project-note UUID (UUID only; legacy project notes use UUIDs on the public API)" } ] }, "description": "" } }, { "name": "List Project Notes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/projects/{project_id}/notes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "projects", "{project_id}", "notes" ], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "Max results per page (1-500); backend defaults to 100 when omitted" }, { "key": "offset", "value": "", "disabled": true, "description": "Results to skip; when omitted the backend defaults to 0" } ], "variable": [ { "key": "project_id", "value": "", "description": "Project ID (integer) or Project UUID" } ] }, "description": "" } }, { "name": "Add Note To Project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/projects/{project_id}/notes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "projects", "{project_id}", "notes" ], "query": [], "variable": [ { "key": "project_id", "value": "", "description": "Project ID (integer) or Project UUID" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"note_detail\": \"Customer mentioned wanting to expand to a second region next quarter.\"\n}" } } } ] }, { "name": "playbooks", "item": [ { "name": "Get All Playbooks", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/playbooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "playbooks" ], "query": [ { "key": "name", "value": "", "disabled": true, "description": "" }, { "key": "is_archived", "value": "", "disabled": true, "description": "" } ], "variable": [] }, "description": "Gets all active playbooks." } }, { "name": "Create A Playbook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/playbooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "playbooks" ], "query": [], "variable": [] }, "description": "Create a playbook.\n\n`description` becomes the playbook's welcome message. `tags` is a list of tag\nnames \u2014 names that don't exist yet are created. `datafields` sets playbook data\nfield values by UUID.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Onboarding Playbook\",\n \"description\": \"\",\n \"tags\": [\n \"Enterprise\",\n \"Onboarding\"\n ],\n \"datafields\": [\n {\n \"datafield_uuid\": \"f9bc450b-52ee-4d88-b8be-aea2c2858f19\",\n \"value\": null\n }\n ]\n}" } } }, { "name": "Get Playbook By Uuid", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/playbooks/{playbook_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "playbooks", "{playbook_uuid}" ], "query": [], "variable": [ { "key": "playbook_uuid", "value": "", "description": "" } ] }, "description": "" } }, { "name": "Update A Playbook", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/playbooks/{playbook_uuid}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "playbooks", "{playbook_uuid}" ], "query": [], "variable": [ { "key": "playbook_uuid", "value": "", "description": "UUID of the playbook to update" } ] }, "description": "Update a playbook's metadata, tags, or data field values.\n\nPartial update \u2014 only the fields you send are changed. `description` is the\nwelcome message. `tags`, when sent, replaces the playbook's entire tag set.\nEditing a superseded playbook version is rejected.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\"\n ],\n \"datafields\": [\n {\n \"datafield_uuid\": \"f9bc450b-52ee-4d88-b8be-aea2c2858f19\",\n \"value\": null\n }\n ]\n}" } } }, { "name": "Archive A Playbook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/playbooks/{playbook_uuid}/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "playbooks", "{playbook_uuid}", "archive" ], "query": [], "variable": [ { "key": "playbook_uuid", "value": "", "description": "" } ] }, "description": "Archive a playbook." } }, { "name": "Get Playbook Data Fields", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/playbooks/{playbook_uuid}/datafields", "host": [ "{{baseUrl}}" ], "path": [ "v1", "playbooks", "{playbook_uuid}", "datafields" ], "query": [], "variable": [ { "key": "playbook_uuid", "value": "", "description": "" } ] }, "description": "Lists the PLAYBOOK-type data field definitions (type, config, defaults) for the vendor\nthat owns the playbook. 404s when the playbook does not exist for the vendor." } }, { "name": "Duplicate A Playbook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/playbooks/{playbook_uuid}/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "playbooks", "{playbook_uuid}", "duplicate" ], "query": [], "variable": [ { "key": "playbook_uuid", "value": "", "description": "" } ] }, "description": "Duplicate a playbook.\n\nCreates a complete, independent copy of the playbook \u2014 modules, tasks, task\nsteps, merge-field usage, data fields, tags, and resources included. Pass\n`name` to choose the copy's name; otherwise it is named\n\"Copy of