Sign in

v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Edit Split Payment Campaign

patch/v1/agent-hub/campaigns/{campaign_id}

Path parameters

campaign_idstring required

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. <br /><br /><b>Possible Values:</b><br /> application/json<br />application/x-www-form-urlencoded

Request body

namestring

Name of split payment campaign. Max 150 characters.

base_chargestring

Base charge of the split payment campaign. Max value: 100.

perc_chargestring

Percentage charge of the split payment campaign. Max value 20.

descriptionstring

Description of split payment campaign. Max 255 characters.

notesstring

Notes of the split payment campaign. Max 500 characters.

is_defaultstring

To set the split payment campaign as the default, send 1.

accountsstring[]

Array of account IDs associated with the split payment campaign.

Response

200

Example response

{
  "data": {
    "object": "Campaign",
    "id": "nvajm67v9gbxrlko",
    "name": "Teste",
    "description": "dsfgsfdg",
    "notes": "sdfgdfsg",
    "status": "active",
    "base_charge": 100,
    "perc_charge": 20,
    "is_default": "0",
    "created_at": "2024-10-18T12:44:03.000000Z",
    "updated_at": "2024-11-04T19:23:44.000000Z",
    "readable_created_at": "2 weeks ago",
    "readable_updated_at": "1 second ago"
  }
}