Add a Masked-Connect Customer

post

https://api.lodgestory.com/api/wp-crm/voice/{organisationId}/mask-configs/{configId}/customers

Create a customer entry: when customerNumber calls the masked DID, the call bridges to followMeNumber.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organisationId

string

required

Your organisation UUID (returned as org from the /token endpoint).

configId

string

required

The masked-connect config UUID (from GET /mask-configs).

Query Params

callingAccountId

string

Which voice account to target. Optional — required only if your organisation has more than one active lodgestory-voice account (see GET /accounts).

Body Params

customerNumber

string

required

The customer's phone number that will call the masked DID (E.164).

followMeNumber

string

required

The real destination (e.g. the delivery agent mobile) the masked call bridges to.

code

string

Optional order/disambiguation code (DTMF). Must be unique among active entries.

label

string

Free-text note (customer name / order ref).

expiresAt

string

Optional expiry (ISO 8601); null/omitted = never expires.

isActive

boolean

Whether the entry is active. Defaults to true.

Responses

400

Bad request — invalid number or duplicate code

401

Unauthorized

403

Forbidden / voice API not enabled

404

Config not found

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201