Skip to main content
POST
Assign contacts to a campaign
Review the contacts, sequence messages, timing, and sender before assigning contacts. Jobin starts the configured sequence after assignment. The 202 Accepted response confirms that Jobin queued the work. It includes jobGroupId and queuedStagePositionCode. Use jobGroupId with List operations to check related work. Review the contact’s sequence activity to confirm the outcome, including when the pending list is empty. Rate limit: 10 requests/minute per endpoint and workgroup. Details.

Authorizations

x-api-key
string
header
required

Primary public authentication method. Create keys in Jobin.cloud under Workgroups > Integrations > Custom integration.

Path Parameters

campaignId
string
required

Body

application/json
contactIds
string[]
required

Contacts to assign in this request. Jobin accepts up to 50 contacts per campaign-assignment call.

Required array length: 1 - 50 elements
Pattern: ^[a-fA-F0-9]{24}$
startPositionCode
string

Optional trimmed, nonempty code of an existing stage in the campaign. Omit to use the default start stage.

Required string length: 1 - 256
addEvenIfAlreadyInCampaign
boolean

Whether contacts already in a campaign may be assigned again. Defaults to false when omitted.

Response

Assignment accepted

accepted
boolean
campaignId
string
contactIds
string[]
jobGroupId
string

Correlation id for listing outstanding operations created by this asynchronous assignment.

queuedStagePositionCode
string

The sequence stage position used for newly queued operations.