API Reference
  1. Lodgestory WhatsApp CRM API
  2. Segments

Start a Segment Import

post
https://api.lodgestory.com/api/wp-crm/segments///imports

Fill a segment in the background — a CSV you uploaded (step 2 after upload-url), or the recipients of a past campaign. Poll GET …/imports/{importId} for progress; people already in the segment are updated, not duplicated.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

string
required

A segment id (segmentId from the list or create response).

Body Params
string
enum
required

CSV — a file you uploaded to the uploadUrl from POST …/upload-url; CAMPAIGN — the people of a past campaign (optionally one of its retarget segments).

Allowed:
string

CSV: the fileKey returned with the upload URL.

columnMap
object

CSV: which of your headers hold phone, countrycode, name, email (defaults: those header names). Every other column becomes a member attribute.

string

CAMPAIGN: the past campaign.

string

CAMPAIGN: which of its recipients (default ALL), e.g. READ_NOT_REPLIED.

Responses

400

Bad request — unknown kind, or a fileKey not uploaded for your organisation

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — role not permitted

404

Segment or source campaign not found

429

Too many requests

Updated about 2 hours ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?