Channel Automation API: endpoints 406–498

Field roles (Marketing, Sales, Installation) with their people and settings

Save one field role's settings and replace its people

Stores, event booths and canvass areas with their shifts (next 14 days) and the people on each

Create a location

Edit a location (any field; a pin or a changed address re-places the fence; status archived hides it)

Add a dated shift (starts_at, ends_at ≤ 24 h, slots, note, user_ids of client team members)

Replace who works a shift (user_ids)

Delete a shift (its assignments and check-ins go with it)

The signed-in person's shifts (12 h ago to 7 days ahead) with each location's fence and their open check-in

Check in at a shift (assigned, shift window from 60 min before start to the end, exact place, inside its fence)

A location reading for the caller's open shift check-in (every ~2 min); 2 outside in a row ends it

Check out of the caller's shift (idempotent)

The consent wording a rep shows a customer before a sign-up (the newest version), or null when none is set

Record a sign-up at the rep's shift with the customer's signed consent (retry-safe on client_capture_id)

Field sign-ups signed in [from, to) with their consent evidence, newest first (managers)

One sign-up with the full consent wording the customer signed (managers)

The consent wording in use and its version history (managers)

Publish new consent wording as the next version (owners and admins). Earlier versions and every signed consent stay as they are.

The consent certificate for one sign-up as a PDF (managers). Generated on demand from the evidence rows, so it includes the latest YES / STOP reply.

Every sign-up in [from, to) with its consent evidence as CSV (managers). from/to ISO, at most 93 days and 5,000 rows.

Every Sales Coach field touch for one contact, newest first (owners, admins, managers who can see the contact)

Required credentials, every team member's credentials and the team with their field roles (managers). include_archived=1 adds archived credentials.

Add a required credential. Body { name, role_key (marketing|sales|installation|null = everyone), remind_days (1-365, default 60) }. 409 duplicate name.

Rename, change the role or remind days, or archive (status) a required credential.

Record or update one person's credential. Body { user_id, type_id, number, issued_on, expires_on (YYYY-MM-DD; none = does not expire), note }. 409 not_eligible / archived.

Remove one person's credential.

Whether a confirmation text ("Reply YES") goes to each new sign-up, and its wording (managers). Off by default.

Turn the confirmation text on or off and set its wording (owners and admins). Body { enabled, message_template }; {company}, {place}, {first_name}; must mention STOP.

The appointment's testimonial link for a customer (any workspace member who can see the contact). Creates the first one, reopens the open one, renews an expired one; replaces_link_id replaces it or starts a new request after a submission (a retry returns the same successor).

What the customer's testimonial page shows (Authorization: Bearer <link code>). Stamps the first open.

Send a written testimonial with consent (Authorization: Bearer <link code>). One per link; a repeat returns the first.

Start (or restart) a video upload for this link's video consent (Authorization: Bearer <link code>). Returns a 2-hour signed resumable-upload token for a new, never-reused path.

The upload finished: the stored video is checked and accepted, then prepared for review (Authorization: Bearer <link code>). Safe to repeat.

Testimonials for review and sharing, newest first, 50 per page (managers). Optional status, offset.

Totals per status for the tiles (managers)

One testimonial with its text or a 15-minute video URL, consent evidence and share link (managers)

Approve, reject or restore (back to review) a testimonial (managers). Body: { action }

Share an approved testimonial; returns its public link (managers). 409 when consent was withdrawn.

Stop sharing; every link handed out stops working (managers)

The customer withdrew consent. Unshares, clears a written review's text or deletes a video's files, and keeps the consent record (managers)

Public link of a shared testimonial on the company API domain; a written review or a video player renders as a page (video URLs signed for 15 minutes); 404 once unshared or withdrawn

Read the workspace's rep intro video settings

Save the workspace's rep intro video settings

Render a draft intro template with a sample customer

The rep's intro options for one assigned visit

Register a rep intro video and get its private upload target

Submit an uploaded intro for sending

Every rep intro video in a date range, for managers

Allow a rep to send a new intro after an unconfirmed send

List active knowledge sources available to an AI agent

Add manual, FAQ, file, or public URL knowledge

Get a knowledge source including its full content

Update a knowledge source and rebuild its chunks

Delete a knowledge source and its chunks

List approved and draft training examples for an AI agent

Add a training example used for style and response shape

Approve a proposed training example into the live prompt

Discard a proposed training example

Update a training example

Delete a training example

Preview the exact knowledge and style examples a question retrieves

Save an internal comment on a contact

Email teammates who were @mentioned in a comment

Play an inbound attachment without exposing messaging credentials

Create a ten-minute phone recording QR code

Read phone recording availability using its QR capability

Upload one phone video with a single-use QR capability

Poll this user's phone recording for the selected contact

Cancel this user's phone recording and remove its raw upload

Prepare a short video for text messaging

Read video preparation progress for a workspace

Refresh existing number voice capabilities

Read workspace rotation configuration

Save workspace rotation configuration

Read workspace sender pool

Park a workspace number

Reactivate a workspace number

Read workspace boards and number boxes

Save a workspace board number box

Read a workspace board number box summary

Read workspace number rotation events

Mint a 10-minute preview token for the signed-in member

Copy the signed-in member's avatar into the private rep photo bucket

The signed-in member's personal rep link and the profile the app shows

Replace the signed-in rep's personal link

List personal links for every public profile in the workspace

Unpublish another member's public profile

Mint the homeowner's Meet Your Rep link for one appointment

Stop follow-ups for a verified contact appointment

Schedule an SMS for a future time (LiveChat, Allison, sequences)