[beta] Creates a campaign.

post

https://api.samsara.com/maintenance/campaigns

Creates a campaign. The campaign is created in your organization's Draft status with createdSource set to api. Creating a campaign never creates work orders or places items on hold.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Campaigns under the Work Orders category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Campaign to create.

campaignNumber

string

Customer or OEM-aligned campaign number.

campaignType

string

enum

required

Type of the campaign. Valid values: safetyRecall, mandatoryCampaign, voluntary, internal

Allowed:

description

string

Free-form description of the campaign.

endTime

date-time

End of the campaign in RFC 3339 format. Must not be before startTime.

isWarranty

boolean

Defaults to false

Whether campaign work is expected to be claimable as warranty or recall work. Defaults to false.

name

string

required

Display name of the campaign.

recallMetadata

object

Recall provenance for a recall-sourced campaign.

startTime

date-time

Start of the campaign in RFC 3339 format.

workOrderPriority

string

enum

Priority applied to work orders generated from the campaign. Uses the same values as the priority field of the Work Orders API. Defaults to no priority. Valid values: High, Low, Medium, Urgent

Allowed:

workOrderTemplateId

string

ID of a work order template, as returned by GET /maintenance/work-order-templates, that pre-populates work orders generated from the campaign.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

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

application/json

200OK response.

401Unauthorized response.

404Not Found response.

405Method Not Allowed response.

413Content Too Large response.

429Too Many Requests response.

500Internal Server Error response.

501Not Implemented response.

502Bad Gateway response.

503Service Unavailable response.

504Gateway Timeout response.

defaultBad Request response.