Campaigns

PATCH /public/v1/campaigns/{campaignId}

Update a campaign's settings.

PATCH /public/v1/campaigns/{campaignId}

PATCH /public/v1/campaigns/{campaignId}

curl --request PATCH \
  --url 'https://api.joinvalley.co/public/v1/campaigns/{CAMPAIGNID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "statusCode": 1,
  "status": true,
  "message": "<string>",
  "data": {
    "campaign": {
      "id": "<string>",
      "name": "<string>",
      "outreach_count_per_day": 1,
      "auto_pilot": true,
      "withdraw_request_after": 1,
      "re_engagement_config": {},
      "status": "<string>"
    }
  }
}

Default Response

Authorizations

  • x-api-key string required header

    Your Valley API key.

Path Parameters

  • campaignId string required

Request Body

application/json
  • name string
  • outreachCountPerDay integer
  • autoPilot boolean
  • withdrawRequestAfter integer
  • reEngagementConfig object
    + Show Child Attributes
    • r_1 integer enum enum

      7 allowed enum values.

    • r_2 integer enum enum

      7 allowed enum values.

    • r_3 integer enum enum

      7 allowed enum values.

    • r_4 integer enum enum

      7 allowed enum values.

    • r_5 integer enum enum

      7 allowed enum values.

    • r_6 integer enum enum

      7 allowed enum values.

    • r_7 integer enum enum

      7 allowed enum values.

    • r_8 integer enum enum

      7 allowed enum values.

    • r_9 integer enum enum

      7 allowed enum values.

    • r_10 integer enum enum

      7 allowed enum values.

    • r_11 integer enum enum

      7 allowed enum values.

    • r_12 integer enum enum

      7 allowed enum values.

Response

application/json
  • statusCode number
  • status boolean
  • message string
  • data object
    + Show Child Attributes
    • campaign object
      + Show Child Attributes
      • id string
      • name string
      • outreach_count_per_day number
      • auto_pilot boolean
      • withdraw_request_after number nullable
      • re_engagement_config object
        + Show Child Attributes
        • [key: string] any additional

          Additional arbitrary properties are allowed.

      • status string