JOjoinvalley
Campaigns

POST /public/v1/campaigns

Changed on

Create a new outreach campaign. By default it belongs to the API key's user. Pass ownerId to create it on a teammate's seat instead: the key's user must be a workspace owner, admin or manager, and the seat must be an active member with LinkedIn connected and not a Manager seat (Manager seats never send). A Manager key must always pass ownerId.

Request

Request body

namestring required
type'MESSAGING' | 'FIRST_DEGREE_MESSAGE' | 'INMAIL' required
mode'AI' | 'TEMPLATED' required
workspaceIdstring required
workspaceProductIdstring required
writingStyleIdstring
templateIdstring
outreachCountPerDayinteger required
autoPilotboolean required
outreachLanguage'English' | 'English (UK)' | 'Albanian' | 'Arabic' | 'Bengali' | 'Bosnian' | 'Bulgarian' | 'Chinese' | 'Croatian' | 'Czech' | 'Danish' | 'Dutch' | 'Egyptian' | 'Farsi' | 'French' | 'German' | 'Greek' | 'Hebrew' | 'Hindi' | 'Hungarian' | 'Indonesian' | 'Italian' | 'Japanese' | 'Korean' | 'Kurdish' | 'Macedonian' | 'Montenegrin' | 'Polish' | 'Portuguese' | 'Romanian' | 'Russian' | 'Serbian' | 'Slovak' | 'Slovenian' | 'Spanish' | 'Spanish (Latin America)' | 'Swahili' | 'Swedish' | 'Thai' | 'Turkish' | 'Urdu' | 'Vietnamese'
includedProfilesstring
withdrawRequestAfterinteger
isBlankConnectboolean
prospectEnrichmentConfigstring[]
inputType'SALES_NAV_SEARCH_URL' | 'LINKEDIN_POST_URL' required
inputUrlstring
scrapeReactionsboolean
scrapeCommentsboolean
ownerIdstring

User id of the teammate whose seat the campaign belongs to and sends from. Owners, admins and managers only. Omit to create it on your own seat.

Response

Default Response

statusCodenumber
statusboolean
messagestring

Changes

  • 798c2eb1b512Revision changes
    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

  • 8997574763c0Revision changes
    • info

      added the new Albanian enum value to the request property

    • info

      added the new Bosnian enum value to the request property

    • info

      added the new Bulgarian enum value to the request property

    • info

      added the new Croatian enum value to the request property

    • info

      added the new Czech enum value to the request property

    • info

      added the new Danish enum value to the request property

    • info

      added the new Dutch enum value to the request property

    • info

      added the new English (UK) enum value to the request property

    • info

      added the new Farsi enum value to the request property

    • info

      added the new Greek enum value to the request property

    • info

      added the new Hebrew enum value to the request property

    • info

      added the new Hungarian enum value to the request property

    • info

      added the new Kurdish enum value to the request property

    • info

      added the new Macedonian enum value to the request property

    • info

      added the new Montenegrin enum value to the request property

    • info

      added the new Romanian enum value to the request property

    • info

      added the new Serbian enum value to the request property

    • info

      added the new Slovak enum value to the request property

    • info

      added the new Slovenian enum value to the request property

    • info

      added the new Spanish (Latin America) enum value to the request property

    • info

      added the new Swahili enum value to the request property

    • info

      added the new Swedish enum value to the request property