contacts

Create a lead-gen campaign

Create a campaign with optional agent context (markdown brief)..

post/contacts/campaigns

Request body

namestring required

Human-readable campaign name. Use a clear, descriptive title. Do NOT use slugs or technical IDs.

descriptionstring

Optional campaign description

languagestring

ISO 639-1 language code (e.g. 'fr', 'en'). Overrides ASCII heuristic for AI task language.

forceboolean

Bypass the duplicate-name guard. Normally the endpoint returns 409 with a suggested existing campaign when name is within Levenshtein 2 of one. Pass force: true after the agent has surfaced the suggestion to the user and they explicitly confirmed they want a second campaign with a similar name. Default: false.

draftMode'review'

Drafted messages wait for a human to approve them before they may send.

Response

Campaign created

successtrue required
creditsUsedinteger required

Credits consumed by this call. 0 for free endpoints, cached results, duplicates, and for every query that does not touch LinkedIn.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.

Changes

Changed in 4 of the 11 revisions of this API.4139

    • removed the required property _meta/credits/accountPlan from the response with the 201 status

      response-required-property-removed

    • added the new pacing enum value to the error/quotaKind response property for the response status 400

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 401

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 403

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 404

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 409

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 410

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 422

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 429

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 500

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 502

      response-property-enum-value-added

    • added the new pacing enum value to the error/quotaKind response property for the response status 503

      response-property-enum-value-added

  • 1ad91026000b229See the full diff
    • removed the enum value autopilot of the request property draftMode

      request-property-enum-value-removed

    • removed the required property campaign/type from the response with the 201 status

      response-required-property-removed

    • removed the request property autopilot

      request-property-removed

    • removed the optional property campaign/autopilot from the response with the 201 status

      response-optional-property-removed

    • added the optional property _meta to the response with the 201 status

      response-optional-property-added

    • added the optional property campaign/brokenReasons to the response with the 201 status

      response-optional-property-added

    • added the optional property campaign/disabledTasks to the response with the 201 status

      response-optional-property-added

    • added the optional property campaign/hiddenIdentities to the response with the 201 status

      response-optional-property-added

    • added the optional property campaign/icpContextId to the response with the 201 status

      response-optional-property-added

    • added the optional property campaign/language to the response with the 201 status

      response-optional-property-added

    • added the optional property campaign/lastTaskAt to the response with the 201 status

      response-optional-property-added

    • added the optional property campaign/leadCapacity to the response with the 201 status

      response-optional-property-added

    • added the optional property campaign/nextAction to the response with the 201 status

      response-optional-property-added

    • removed the required property campaign/stageCounts/approved from the response with the 201 status

      response-required-property-removed

Of the 11 revisions, 1 has no diff computed.