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

Owner, admin or manager (database role) who can see the contact. The appointment and its contact must belong to the caller's workspace. Returns the link, the visit state, and an editable SMS suggestion that is present only while the visit is upcoming. Set REP_PAGE_MINTING_DISABLED=true to stop all minting (503).

GET

https://api.channelautomation.com/api/rep-profiles/appointment/{appointmentId}/link

Path parameters

appointmentId
string
required
format: uuid

Header parameters

x-workspace-id
optional
string

Returns

200

{ url, state, rep_state, rep_name, assigned_rep_name, can_send, blocked_reason, suggested_text, opened_at, open_count, intro_video }

403

Not an owner, admin or manager, or cannot see this contact.

404

Appointment or contact is not in this workspace.

503

Minting is disabled or not configured, or the database surface is missing.

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

curl --request GET \
  --url 'https://api.channelautomation.com/api/rep-profiles/appointment/<appointmentId>/link'

const url = 'https://api.channelautomation.com/api/rep-profiles/appointment/<appointmentId>/link';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));