Configure SMS Campaign

Update one or more parts of an SMS campaign configuration. The campaign must be in DRAFT status. Each top-level field is optional; omitted fields remain unchanged.

---

Endpoint

PATCH https://api.campaignlark.com/v1/sms-campaigns/:id/configure

---

Path Parameters

Parameter	Type	Required	Description
id	string	required	Campaign ID as a MongoDB ObjectID hex string.

---

Request Body

Field	Type	Required	Description
name	string	optional	Campaign name. Must be 1–255 characters when provided.
message	string	optional	SMS message. Must be 1–1600 characters when provided.
audience	array	optional	Audience configuration. Providing it replaces the existing audience.
audience[].type	string	required when audience is provided	ENTIRE_AUDIENCE, TAGS, or SEGMENTS.
audience[].tags	array of integers	required for TAGS	Tags to include.
audience[].segments	array of integers	required for SEGMENTS	Segments to include.
audience[].exclude_tags	array of integers	optional	Tags to exclude.
audience[].exclude_segments	array of integers	optional	Segments to exclude.

---

Sample Request

PATCH https://api.campaignlark.com/v1/sms-campaigns/64f1a2b3c4d5e6f7a8b9c0d1/configure
Content-Type: application/json

{
  "name": "Summer Sale SMS",
  "message": "Summer sale: 20% off today. https://example.com/sale",
  "audience": [
    {
      "type": "SEGMENTS",
      "segments": [2, 7],
      "exclude_segments": [4]
    }
  ]
}

---

Response

Success — 200 OK

Returns the updated SMS campaign object in the same shape as Get SMS Campaign.

---

Errors

Status	Message	Cause
400	Invalid request body.	The request body could not be parsed.
400	Please provide a campaign ID.	id is missing.
400	We could not find the campaign you are looking for.	The ID is malformed or the campaign does not exist in the workspace.
400	Please provide a name for this campaign.	name is empty or whitespace.
400	The campaign name must be 255 characters or less.	name exceeds 255 characters.
400	Please provide a message for this campaign.	message is empty or whitespace.
400	The message must be 1600 characters or less.	message exceeds 1600 characters.
400	Please configure an audience for this campaign.	audience is empty.
400	At least one tag is required for this audience.	A TAGS audience has no included tags.
400	At least one segment is required for this audience.	A SEGMENTS audience has no included segments.
400	Invalid tag ID provided.	A tag ID is not positive.
400	Invalid segment ID provided.	A segment ID is not positive.
400	One or more tags could not be found.	A referenced tag does not exist in the workspace.
400	One or more segments could not be found.	A referenced segment does not exist in the workspace.
400	Invalid exclude tag ID provided.	An excluded tag ID is not positive.
400	Invalid exclude segment ID provided.	An excluded segment ID is not positive.
400	One or more exclude tags could not be found.	A referenced excluded tag does not exist.
400	One or more exclude segments could not be found.	A referenced excluded segment does not exist.
400	Invalid audience type. Must be 'ENTIRE_AUDIENCE', 'TAGS', or 'SEGMENTS'.	The audience type is invalid.
400	Archived campaigns cannot be edited.	The campaign is archived.
400	Only draft campaigns can be edited.	The campaign is not in DRAFT status.