openapi.city
Sign in

ActiveCampaign

Email marketing and CRM automation

developers.activecampaign.com/reference ↗
Version
3
OpenAPI
3.0.3
Endpoints
257
Schemas
571
Updated
about 1 hour ago
Email email marketing crm automation
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://{youraccountname}.api-us1.com/api/3

Authentication

apiKey

Endpoints

Clear filters
GET POST PUT PATCH DELETE

Account 2 endpoints

PUT /accountContacts/{id}

Update an existing account association

operationId: Account_updateAssociation

Parameters

Name In Required Type Description
id path required integer Association's ID

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AccountUpdateAssociationRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "accountContact": {
              "jobTitle": "Product Manager"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
PUT /accountContacts/{id}
PUT /accounts/{id}

Update an existing account

operationId: Account_updateExisting

Parameters

Name In Required Type Description
id path required integer Account's id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AccountUpdateExistingRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "account": {
              "name": "Exmaple Account",
              "fields": [
                {
                  "fieldValue": "500-1000",
                  "customFieldId": 9
                },
                {
                  "fieldValue": 1234,
                  "customFieldId": 20,
                  "fieldCurrency": "GBP"
                }
              ],
              "accountUrl": "https://www.example.com"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /accounts/{id}

Address 1 endpoints

PUT /addresses/{id}
operationId: Address_updateAddress

Parameters

Name In Required Type Description
id path required integer ID of the Address being changed

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AddressUpdateAddressRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "address": {
              "zip": "12345",
              "city": "New Test City",
              "state": "Florida",
              "country": "US",
              "address1": "111 New Test Address",
              "address2": "",
              "companyName": "New Test Company Name"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
404 404
PUT /addresses/{id}

Branding 1 endpoints

PUT /brandings/{id}

Update an existing branding resource

operationId: Branding_updateExistingResource

Parameters

Name In Required Type Description
id path required integer Branding ID

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/BrandingUpdateExistingResourceRequest"
      }
    }
  }
}

Responses

200 200
400 400
PUT /brandings/{id}

Calendar 1 endpoints

PUT /calendars/{id}
operationId: Calendar_updateFeed

Parameters

Name In Required Type Description
id path required integer ID of the calendar feed to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CalendarUpdateFeedRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "calendar": {
              "type": "Deals",
              "title": "Calendar Title",
              "notification": 0
            }
          }
        }
      }
    }
  }
}

Responses

200 200
PUT /calendars/{id}

Config 1 endpoints

PUT /configs/{id}
operationId: Config_updateSettings

Parameters

Name In Required Type Description
id path required string ID of the config to edit

Responses

200 200
404 404
PUT /configs/{id}

Connection 1 endpoints

PUT /connections/{id}

Update an existing connection resource.

operationId: Connection_updateExistingConnection

Parameters

Name In Required Type Description
id path required string The id of the connection to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ConnectionUpdateExistingConnectionRequest"
      },
      "examples": {
        "JSON": {
          "value": {
            "connection": {
              "name": "Acme, Inc.",
              "externalid": "johndoe@example.com"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /connections/{id}

Contact 1 endpoints

PUT /contacts/{id}
operationId: Contact_updateContact

Parameters

Name In Required Type Description
id path required integer ID of the contact to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ContactUpdateContactRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "contact": {
              "email": "johndoe@example.com",
              "lastName": "Doe",
              "firstName": "John",
              "fieldValues": [
                {
                  "field": "1",
                  "value": "The Value for First Field"
                },
                {
                  "field": "6",
                  "value": "2008-01-20"
                }
              ]
            }
          }
        }
      }
    }
  }
}

Responses

200 200
404 404
PUT /contacts/{id}

Customer 1 endpoints

PUT /ecomCustomers/{id}

Update an existing e-commerce customer resource.

operationId: Customer_updateResource

Parameters

Name In Required Type Description
id path required string The id of the customer to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CustomerUpdateResourceRequest"
      },
      "examples": {
        "JSON": {
          "value": {
            "ecomCustomer": {
              "externalid": "98765"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
PUT /ecomCustomers/{id}

Deal 11 endpoints

PUT /contactDeals/{id}

Update an existing secondary contact

operationId: Deal_updateSecondaryContact

Parameters

Name In Required Type Description
id path required integer Secondary Contact's id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealUpdateSecondaryContactRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "contactDeal": {
              "deal": 1,
              "role": 1,
              "contact": 4
            }
          }
        }
      }
    }
  }
}

Responses

200 200
404 404
422 422
PUT /contactDeals/{id}
PUT /dealCustomFieldData/{id}
operationId: Deal_updateCustomFieldValue

Parameters

Name In Required Type Description
id path required integer ID of the custom fields value to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealUpdateCustomFieldValueRequest"
      },
      "examples": {
        "date": {
          "value": {
            "dealCustomFieldDatum": {
              "fieldValue": "2018-12-31 00:00:00"
            }
          }
        },
        "number": {
          "value": {
            "dealCustomFieldDatum": {
              "fieldValue": "100.99"
            }
          }
        },
        "currency": {
          "value": {
            "dealCustomFieldDatum": {
              "fieldValue": 9999,
              "fieldCurrency": "cad"
            }
          }
        },
        "dropdown/radio": {
          "value": {
            "dealCustomFieldDatum": {
              "fieldValue": "option 1"
            }
          }
        },
        "text/textarea/hidden": {
          "value": {
            "dealCustomFieldDatum": {
              "fieldValue": "New title"
            }
          }
        },
        "multiselect/checkbox (single)": {
          "value": {
            "dealCustomFieldDatum": {
              "fieldValue": [
                "option 1"
              ]
            }
          }
        },
        "multiselect/checkbox (multiple)": {
          "value": {
            "dealCustomFieldDatum": {
              "fieldValue": [
                "option 1",
                "option 3",
                "option 4"
              ]
            }
          }
        }
      }
    }
  }
}

Responses

200 200
404 404
422 422
PUT /dealCustomFieldData/{id}
PUT /dealCustomFieldMeta/{id}
operationId: Deal_updateCustomFieldMeta

Parameters

Name In Required Type Description
id path required integer ID of the custom field to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealUpdateCustomFieldMetaRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "dealCustomFieldMetum": {
              "fieldLabel": "New Title",
              "displayOrder": 1,
              "fieldDefault": "Default Text",
              "isFormVisible": 1
            }
          }
        }
      }
    }
  }
}

Responses

200 200
404 404
PUT /dealCustomFieldMeta/{id}
PUT /dealGroups/{id}

Update an existing pipeline

operationId: Deal_updatePipeline

Parameters

Name In Required Type Description
id path required integer Pipeline's id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealUpdatePipelineRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "dealGroup": {
              "title": "Qualifications",
              "users": [
                "3"
              ],
              "groups": [],
              "allusers": 0,
              "currency": "eur",
              "allgroups": 1,
              "autoassign": 1
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /dealGroups/{id}
PUT /dealStages/{id}

Update an existing stage

operationId: Deal_updateStage

Parameters

Name In Required Type Description
id path required integer Deal stage's id
reorder query optional integer Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of `0` and `1`. If set to `1`, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest `id` will be assigned with the lowest `order`

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealUpdateStageRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "dealStage": {
              "color": "696969",
              "group": "4",
              "order": 1,
              "title": "Qualifications - Low",
              "width": 270,
              "dealOrder": "title ASC",
              "cardRegion1": "contact-orgname",
              "cardRegion2": "next-action",
              "cardRegion3": "hide-avatar",
              "cardRegion4": "contact-fullname-orgname",
              "cardRegion5": "value"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /dealStages/{id}
PUT /dealStages/{id}/deals

Move all deals in one stage to another stage

operationId: Deal_moveDealsToAnotherStage

Parameters

Name In Required Type Description
id path required integer Deal stage's id whose deals are to be moved to another deal stage

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealMoveDealsToAnotherStageRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "deal": {
              "stage": "3"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
422 422
PUT /dealStages/{id}/deals
PUT /dealTasks/{id}

Update an existing task

operationId: Deal_updateTaskById

Parameters

Name In Required Type Description
id path required integer The ID of the task

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealUpdateTaskByIdRequest"
      }
    }
  }
}

Responses

201 201
400 400
PUT /dealTasks/{id}
PUT /dealTasktypes/{id}

Update an existing task type

operationId: Deal_updateTaskType

Parameters

Name In Required Type Description
id path required integer Deal task type's id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealUpdateTaskTypeRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "dealTasktype": {
              "title": "Meet in person",
              "status": 1
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /dealTasktypes/{id}
PUT /dealTasktypes/{id}/dealTasks

Move tasks to a different task type

operationId: Deal_moveTasksToAnotherTaskType

Parameters

Name In Required Type Description
id path required integer Deal task type's id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealMoveTasksToAnotherTaskTypeRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "dealTask": {
              "dealTasktype": "2"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /dealTasktypes/{id}/dealTasks
PUT /deals/{id}

Update an existing deal

operationId: Deal_updateExistingDeal

Parameters

Name In Required Type Description
id path required integer The Deal's id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealUpdateExistingDealRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "deal": {
              "group": "1",
              "owner": "1",
              "stage": "1",
              "title": "AC Deal",
              "value": 45600,
              "fields": [
                {
                  "fieldValue": "First field value",
                  "customFieldId": 1
                },
                {
                  "fieldValue": "2008-01-20",
                  "customFieldId": 2
                },
                {
                  "fieldValue": 8800,
                  "customFieldId": 3,
                  "fieldCurrency": "USD"
                }
              ],
              "status": 0,
              "account": "45",
              "contact": "51",
              "percent": null,
              "currency": "usd",
              "description": "This deal is an important deal"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /deals/{id}
PUT /deals/{id}/notes/{noteId}

Update an existing note for a deal

operationId: Deal_updateNote

Parameters

Name In Required Type Description
id path required string Deal's id to assign new note to
noteId path required string Deal note's id to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DealUpdateNoteRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "note": {
              "note": "Update with more info"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
PUT /deals/{id}/notes/{noteId}

Event 1 endpoints

PUT /eventTracking

Enable or disable event tracking

operationId: Event_toggleStatus

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EventToggleStatusRequest"
      },
      "examples": {
        "Enable": {
          "value": {
            "eventTracking": {
              "enabled": true
            }
          }
        },
        "Disable": {
          "value": {
            "eventTracking": {
              "enabled": false
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /eventTracking

Field 5 endpoints

PUT /accountCustomFieldData/{id}
operationId: Field_updateCustomFieldValue

Parameters

Name In Required Type Description
id path required integer ID of the custom fields value to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FieldUpdateCustomFieldValueRequest"
      },
      "examples": {
        "text/textarea/hidden": {
          "value": {
            "accountCustomFieldDatum": {
              "fieldValue": "New title"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
404 404
PUT /accountCustomFieldData/{id}
PUT /accountCustomFieldMeta/{id}
operationId: Field_updateCustomFieldMeta

Parameters

Name In Required Type Description
id path required integer ID of the custom field to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FieldUpdateCustomFieldMetaRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "accountCustomFieldMetum": {
              "fieldLabel": "New Title",
              "displayOrder": 1,
              "fieldDefault": "Default Text",
              "isFormVisible": 1
            }
          }
        }
      }
    }
  }
}

Responses

200 200
404 404
PUT /accountCustomFieldMeta/{id}
PUT /fieldValues/{id}
operationId: Field_updateCustomValue

Parameters

Name In Required Type Description
id path required string ID of the fieldValue to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FieldUpdateCustomValueRequest"
      },
      "examples": {
        "date value": {
          "value": {
            "fieldValue": {
              "field": 7,
              "value": "2018-12-31",
              "contact": 2
            }
          }
        },
        "datetime value (ISO)": {
          "value": {
            "fieldValue": {
              "field": 7,
              "value": "2020-05-19T02:45:00-05:00",
              "contact": 2
            }
          }
        },
        "dropdown/radio value": {
          "value": {
            "fieldValue": {
              "field": 5,
              "value": "Option 1",
              "contact": 2
            }
          }
        },
        "text/textarea/hidden value": {
          "value": {
            "fieldValue": {
              "field": 24,
              "value": "Blue",
              "contact": 4
            },
            "useDefaults": true
          }
        },
        "checkbox/listbox values (single)": {
          "value": {
            "fieldValue": {
              "field": 6,
              "value": "||Option 2||",
              "contact": 2
            }
          }
        },
        "checkbox/listbox values (multiple)": {
          "value": {
            "fieldValue": {
              "field": 6,
              "value": "||Option 1||Option 3||Option 4||",
              "contact": 2
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /fieldValues/{id}
PUT /fields/{id}
operationId: Field_updateCustomField

Parameters

Name In Required Type Description
id path required integer ID of the field to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FieldUpdateCustomFieldRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "field": {
              "cols": 2,
              "rows": 2,
              "type": "textarea",
              "title": "Title",
              "defval": "Defaut Value",
              "perstag": "Personalized Tag",
              "service": "google",
              "visible": 1,
              "descript": "Field  description",
              "ordernum": 3,
              "show_in_list": 1
            }
          }
        }
      }
    }
  }
}

Responses

200 200
403 403
PUT /fields/{id}
PUT /groupMembers/{groupId}
operationId: Field_updateCustomFieldGroup

Parameters

Name In Required Type Description
groupId path required string Field group ID (see notes)

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FieldUpdateCustomFieldGroupRequest"
      },
      "examples": {
        "POST": {
          "value": {
            "groupMember": {
              "rel_id": "10",
              "group_id": "1",
              "ordernum": null
            }
          }
        }
      }
    }
  }
}

Responses

200 200
403 403
404 404
422 422
PUT /groupMembers/{groupId}

Group 1 endpoints

PUT /groups/{id}
operationId: Group_updateGroupById

Parameters

Name In Required Type Description
id path required integer ID of the group to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GroupUpdateGroupByIdRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "group": {
              "title": "TEST TITLE",
              "pgDeal": 1,
              "descript": "Description Text",
              "pgListAdd": 1,
              "pgFormEdit": 1,
              "pgGroupAdd": 1,
              "pgListEdit": 1,
              "socialdata": 0,
              "pgGroupEdit": 1,
              "pg_user_add": "0",
              "reqApproval": 1,
              "optinconfirm": "0",
              "pgContactAdd": 1,
              "pgDealDelete": 1,
              "pgListBounce": 1,
              "pgListDelete": 1,
              "pgMessageAdd": 1,
              "pg_user_edit": "0",
              "pgContactEdit": 1,
              "pgContactSync": 1,
              "pgGroupDelete": 1,
              "pgListHeaders": 1,
              "pgMessageEdit": 1,
              "pgMessageSend": 1,
              "pgReportsList": 1,
              "pgReportsUser": 1,
              "pgTemplateAdd": 1,
              "pgContactMerge": 1,
              "pgDealGroupAdd": 1,
              "pgDealReassign": 1,
              "pgReportsTrend": 1,
              "pgTemplateEdit": 1,
              "pg_user_delete": "0",
              "reqApproval1st": 1,
              "pgContactDelete": 1,
              "pgContactExport": 1,
              "pgContactFields": 1,
              "pgContactImport": 1,
              "pgDealGroupEdit": 1,
              "pgMessageDelete": 1,
              "unsubscribelink": "0",
              "pgContactActions": 1,
              "pgContactApprove": 1,
              "pgContactFilters": 1,
              "pgStartupReports": 1,
              "pgTemplateDelete": 1,
              "pgDealGroupDelete": 1,
              "pgReportsCampaign": 1,
              "reqApprovalNotify": "JohnDoe@gmail.com",
              "pgAutomationManage": 1,
              "pgListEmailaccount": 1,
              "pgPersonalizationAdd": 1,
              "pgPersonalizationEdit": 1,
              "pgSavedResponsesManage": 1,
              "pgPersonalizationDelete": 1,
              "pgStartupGettingstarted": 1
            }
          }
        }
      }
    }
  }
}

Responses

200 200
403 403
PUT /groups/{id}

Message 1 endpoints

PUT /messages/{id}
operationId: Message_updateById

Parameters

Name In Required Type Description
id path required string ID of the message to update
message.fromname header optional string Name of sender
message.email header optional string Email of sender
message.reply2 header optional string Reply email for the recipient to reply to
message.subject header optional string Subject of message
message.preheader_text header optional string Preheader Text

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MessageUpdateByIdRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "message": {
              "reply2": "hello@example.com",
              "subject": "You are subscribing to %LISTNAME%",
              "fromname": "John Doe",
              "fromemail": "noreply@example.com",
              "preheader_text": "Pre-header Text"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
404 404
PUT /messages/{id}

Note 2 endpoints

PUT /accounts/{id}/notes/{noteid}

Update an existing note for a account

operationId: Note_updateNote

Parameters

Name In Required Type Description
id path required string Account's id to assign new note to
noteid path required string Account note's id to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/NoteUpdateNoteRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "note": {
              "note": "Update with more info"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
PUT /accounts/{id}/notes/{noteid}
PUT /notes/{id}
operationId: Note_updateNoteById

Parameters

Name In Required Type Description
id path required string ID of the note to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/NoteUpdateNoteByIdRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "note": {
              "note": "This is the text of the note",
              "relid": 2,
              "reltype": "Subscriber"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
403 403
PUT /notes/{id}

Order 1 endpoints

PUT /ecomOrders/{id}

Update an existing ecommerce order/cart resource.

operationId: Order_updateOrderResource

Parameters

Name In Required Type Description
id path required string The ID of the order to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrderUpdateOrderResourceRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "ecomOrder": {
              "email": "alice@example.com",
              "currency": "USD",
              "taxAmount": 500,
              "externalid": "3246315237",
              "totalPrice": 9111,
              "orderNumber": "12345-1",
              "orderProducts": [
                {
                  "sku": "POGO-12",
                  "name": "Pogo Stick",
                  "price": 4900,
                  "category": "Toys",
                  "imageUrl": "https://example.com/product.jpg",
                  "quantity": 1,
                  "externalid": "PROD12345",
                  "productUrl": "https://store.example.com/product12345",
                  "description": "lorem ipsum..."
                },
                {
                  "sku": "SK8BOARD145",
                  "name": "Skateboard",
                  "price": 3000,
                  "category": "Toys",
                  "imageUrl": "https://example.com/product.jpg",
                  "quantity": 1,
                  "externalid": "PROD23456",
                  "productUrl": "https://store.example.com/product45678",
                  "description": "lorem ipsum..."
                }
              ],
              "discountAmount": 100,
              "orderDiscounts": [
                {
                  "name": "1OFF",
                  "type": "order",
                  "discountAmount": 100
                }
              ],
              "shippingAmount": 200,
              "shippingMethod": "UPS Ground",
              "externalUpdatedDate": "2016-09-15T17:41:39-04:00"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
PUT /ecomOrders/{id}

Outcome 1 endpoints

PUT /taskOutccomes/{id}

Update an existing task outcome

operationId: Outcome_updateTaskOutcome

Parameters

Name In Required Type Description
id path required integer Task outcome's id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OutcomeUpdateTaskOutcomeRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "taskOutcome": {
              "sentiment": "Neutral"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
422 422
PUT /taskOutccomes/{id}

Response 1 endpoints

PUT /savedResponses/{id}
operationId: Response_updateSavedResponse

Parameters

Name In Required Type Description
id path required integer ID of the saved response to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ResponseUpdateSavedResponseRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "savedResponse": {
              "body": "Response body",
              "title": "Response title",
              "subject": "Response subject"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
422 422
PUT /savedResponses/{id}

Schema 1 endpoints

PUT /customObjects/schemas/{schemaId}

Make an update to a given schema. To delete a schema field, reference the field delete endpoint: https://developers.activecampaign.com/reference/delete-a-field-1 Users are encouraged to leverage the `?showFields=all` query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a `status: marked_for_deletion` attribute.

operationId: Schema_updateSchema

Parameters

Name In Required Type Description
schemaId path required string Id of Schema being updated
validateOnly header optional boolean When set to `true` the API will validate the schema update without saving changes
showFields query optional string Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default.

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SchemaUpdateSchemaRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "schema": {
              "slug": "stripe-order",
              "appId": "123456",
              "icons": {
                "default": "https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png"
              },
              "fields": [
                {
                  "id": "name",
                  "type": "text",
                  "labels": {
                    "plural": "Product Name",
                    "singular": "Product Name"
                  },
                  "origin": "stripe",
                  "isRequired": true,
                  "description": "Name of the product from the Stripe integration"
                },
                {
                  "id": "total",
                  "type": "currency",
                  "labels": {
                    "plural": "Order Totals",
                    "singular": "Order Total"
                  },
                  "origin": "stripe",
                  "isRequired": true,
                  "description": "Total cost of the order",
                  "defaultCurrency": "USD"
                },
                {
                  "id": "status",
                  "type": "dropdown",
                  "labels": {
                    "plural": "Order Statuses",
                    "singular": "Order Status"
                  },
                  "origin": "stripe",
                  "options": [
                    {
                      "value": "Processed"
                    }
                  ],
                  "isRequired": true,
                  "description": "Status of the order"
                },
                {
                  "id": "features",
                  "type": "multiselect",
                  "labels": {
                    "plural": "Order Features",
                    "singular": "Order Feature"
                  },
                  "origin": "stripe",
                  "options": [
                    {
                      "value": "Expedited Shipping"
                    }
                  ],
                  "isRequired": true,
                  "description": "Extra features for the order"
                },
                {
                  "id": "rating",
                  "type": "decimal",
                  "scale": 2,
                  "labels": {
                    "plural": "Order Ratings",
                    "singular": "Order Rating"
                  },
                  "origin": "stripe",
                  "isRequired": true,
                  "description": "Customer satisfaction rating"
                }
              ],
              "labels": {
                "plural": "Stripe Orders",
                "singular": "Stripe Order"
              },
              "description": "Orders placed through the Stripe integration",
              "relationships": [
                {
                  "id": "primary-contactX",
                  "labels": {
                    "plural": "Primary Contacts",
                    "singular": "Primary Contact"
                  },
                  "hasMany": false,
                  "namespace": "contacts",
                  "description": "Products purchased in this Stripe order"
                }
              ]
            }
          }
        }
      }
    }
  }
}

Responses

200 200
404 404
422 422
PUT /customObjects/schemas/{schemaId}

Tag 1 endpoints

PUT /tags/{id}
operationId: Tag_updateTag

Parameters

Name In Required Type Description
id path required integer ID of the tag to update

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TagUpdateTagRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "tag": {
              "tag": "My Tag",
              "tagType": "contact",
              "description": "Description"
            }
          }
        }
      }
    }
  }
}

Responses

200 200
PUT /tags/{id}

Tracking 1 endpoints

PUT /siteTracking

Enable or disable site tracking

operationId: Tracking_enableDisableSite

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TrackingEnableDisableSiteRequest"
      },
      "examples": {
        "Enable": {
          "value": {
            "siteTracking": {
              "enabled": true
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /siteTracking

User 1 endpoints

PUT /users/{id}

Update an existing user

operationId: User_updateExistingUser

Parameters

Name In Required Type Description
id path required integer ID of the user

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/UserUpdateExistingUserRequest"
      }
    }
  }
}

Responses

200 200
400 400
PUT /users/{id}

Webhook 1 endpoints

PUT /webhooks/{id}

Update an existing webhook

operationId: Webhook_updateExisting

Parameters

Name In Required Type Description
id path required integer The webhook id

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/WebhookUpdateExistingRequest"
      },
      "examples": {
        "Request Example": {
          "value": {
            "webhook": {
              "url": "http://example.com/my-hook",
              "name": "My Hook",
              "events": [
                "subscribe",
                "unsubscribe",
                "sent"
              ],
              "sources": [
                "public",
                "system"
              ]
            }
          }
        }
      }
    }
  }
}

Responses

200 200
400 400
PUT /webhooks/{id}

Schemas

object AccountCreateAssociationRequest 
{
  "type": "object",
  "properties": {
    "accountContact": {
      "type": "object",
      "required": [
        "account",
        "contact"
      ],
      "properties": {
        "account": {
          "type": "integer",
          "format": "int32",
          "description": "Account ID"
        },
        "contact": {
          "type": "integer",
          "format": "int32",
          "description": "Contact ID"
        },
        "jobTitle": {
          "type": "string",
          "description": "Job Title of the contact at the account"
        }
      }
    }
  }
}
object AccountCreateNewAccountRequest 
{
  "type": "object",
  "properties": {
    "account": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Account's name"
        },
        "owner": {
          "type": "integer",
          "format": "int32",
          "default": 1,
          "description": "The userId of the account owner."
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "customFieldId",
              "fieldValue"
            ],
            "properties": {
              "fieldValue": {
                "type": "string",
                "description": "Updated field value. For `currency` field, this needs to be in cents not dollars (or 100 x Base Unit)."
              },
              "customFieldId": {
                "type": "integer",
                "format": "int32",
                "description": "Field ID, ID of the Custom Field Meta Data"
              },
              "fieldCurrency": {
                "type": "string",
                "description": "Required only for the `currency` field type. The three letter currency code for the currency value"
              }
            }
          },
          "description": "Account's custom field values `{customFieldId: int, fieldValue: string, fieldCurrency?:string}[]`"
        },
        "accountUrl": {
          "type": "string",
          "description": "Account's website"
        }
      }
    }
  }
}
object AccountUpdateAssociationRequest 
{
  "type": "object",
  "properties": {
    "accountContact": {
      "type": "object",
      "required": [
        "account",
        "contact"
      ],
      "properties": {
        "account": {
          "type": "integer",
          "format": "int32",
          "description": "Account ID"
        },
        "contact": {
          "type": "integer",
          "format": "int32",
          "description": "Contact ID"
        },
        "jobTitle": {
          "type": "string",
          "description": "Job Title of the contact at the account"
        }
      }
    }
  }
}
object AccountUpdateExistingRequest 
{
  "type": "object",
  "properties": {
    "account": {
      "type": "object",
      "required": [],
      "properties": {
        "name": {
          "type": "string",
          "description": "Account's name"
        },
        "owner": {
          "type": "integer",
          "format": "int32",
          "default": 1,
          "description": "The userId of the Account owner."
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "customFieldId",
              "fieldValue"
            ],
            "properties": {
              "fieldValue": {
                "type": "string",
                "description": "Updated field value. For `currency` field, this needs to be in cents not dollars (or 100 x Base Unit)."
              },
              "customFieldId": {
                "type": "integer",
                "format": "int32",
                "description": "Field ID, ID of the Custom Field Meta Data"
              },
              "fieldCurrency": {
                "type": "string",
                "description": "Required only for the `currency` field type. The three letter currency code for the currency value"
              }
            }
          },
          "description": "Account's custom field values `{customFieldId: int, fieldValue: string, fieldCurrency?:string}[]`"
        },
        "accountUrl": {
          "type": "string",
          "description": "Account's website"
        }
      }
    }
  }
}
object AddressCreateNewAddressRequest 
{
  "type": "object",
  "properties": {
    "address": {
      "type": "object",
      "required": [
        "company_name",
        "address_1",
        "country"
      ],
      "properties": {
        "zip": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "global": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "description": "Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')"
        },
        "groupid": {
          "type": "integer",
          "format": "int32"
        },
        "allgroup": {
          "type": "integer",
          "format": "int32"
        },
        "district": {
          "type": "string",
          "description": "(Optional for countries that use it)"
        },
        "address_1": {
          "type": "string"
        },
        "address_2": {
          "type": "string"
        },
        "is_default": {
          "type": "boolean",
          "description": "Indicates default address"
        },
        "company_name": {
          "type": "string"
        }
      }
    }
  }
}
object AddressUpdateAddressRequest 
{
  "type": "object",
  "properties": {
    "address": {
      "type": "object",
      "required": [
        "company_name",
        "address_1",
        "country"
      ],
      "properties": {
        "zip": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "global": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "description": "Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')"
        },
        "groupid": {
          "type": "integer",
          "format": "int32"
        },
        "allgroup": {
          "type": "integer",
          "format": "int32"
        },
        "district": {
          "type": "string",
          "description": "(Optional for countries that use it)"
        },
        "address_1": {
          "type": "string"
        },
        "address_2": {
          "type": "string"
        },
        "is_default": {
          "type": "boolean",
          "description": "Indicates default address"
        },
        "company_name": {
          "type": "string"
        }
      }
    }
  }
}
object BrandingUpdateExistingResourceRequest 
{
  "type": "object",
  "properties": {
    "branding": {
      "type": "object",
      "required": [],
      "properties": {
        "help": {
          "type": "string"
        },
        "links": {
          "type": "boolean",
          "description": "External links. To enable (which is the default) exclude this parameter entirely. To disable (remove our branding), just pass this parameter with any value."
        },
        "favicon": {
          "type": "string",
          "description": "URL of the favicon."
        },
        "groupid": {
          "type": "integer",
          "format": "int32",
          "default": 3,
          "description": "The group ID. This value will always be 3."
        },
        "license": {
          "type": "boolean",
          "description": "unknown"
        },
        "version": {
          "type": "boolean",
          "description": "unknown"
        },
        "siteLogo": {
          "type": "string"
        },
        "siteName": {
          "type": "string",
          "description": "Title of software. Example: 'ActiveCampaign Email Marketing'"
        },
        "copyright": {
          "type": "boolean",
          "description": "unknown"
        },
        "siteLogoSmall": {
          "type": "string",
          "description": "URL of small logo. Small logos appear in the header of the admin panel."
        },
        "footerHtmlValue": {
          "type": "string",
          "description": "Content of non-removeable footer. Example: <p>footer content here</p>"
        },
        "footerTextValue": {
          "type": "string",
          "description": "Content of non-removeable footer. Example: text footer content"
        },
        "headerHtmlValue": {
          "type": "string",
          "description": "Content of non-removable header. Example: <p>header content here</p>"
        },
        "headerTextValue": {
          "type": "string",
          "description": "Content of non-removable header. Example: text header content"
        },
        "adminTemplateCss": {
          "type": "string",
          "description": "The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)"
        },
        "adminTemplateHtm": {
          "type": "string",
          "description": "The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)"
        },
        "publicTemplateCss": {
          "type": "string",
          "description": "The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)"
        },
        "publicTemplateHtm": {
          "type": "string",
          "description": "The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)"
        }
      }
    }
  }
}
object CalendarCreateFeedRequest 
{
  "type": "object",
  "properties": {
    "calendar": {
      "type": "object",
      "required": [
        "title",
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Possible Values: 'All', 'Deals', or 'Contacts'"
        },
        "title": {
          "type": "string",
          "description": "Title of the calendar feed"
        },
        "notification": {
          "type": "boolean",
          "description": "Whether or not this calendar has notifications"
        }
      }
    }
  }
}
object CalendarUpdateFeedRequest 
{
  "type": "object",
  "properties": {
    "calendar": {
      "type": "object",
      "required": [],
      "properties": {
        "type": {
          "type": "string",
          "description": "Possible Values: 'All', 'Deals', or 'Contacts'"
        },
        "title": {
          "type": "string",
          "description": "Title of the calendar feed"
        },
        "notification": {
          "type": "boolean",
          "description": "Whether or not this calendar has notifications"
        }
      }
    }
  }
}
object FieldBulkCreateCustomAccountFieldValueRequest 
{
  "type": "object",
  "properties": {
    "array": {
      "type": "object",
      "required": [
        "customerAccountId",
        "customFieldId",
        "fieldValue"
      ],
      "properties": {
        "fieldValue": {
          "type": "string",
          "description": "Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)"
        },
        "customFieldId": {
          "type": "integer",
          "format": "int32",
          "description": "The ID of the custom field metum this field value relates to"
        },
        "fieldCurrency": {
          "type": "string",
          "description": "Currency code for the money value"
        },
        "customerAccountId": {
          "type": "integer",
          "format": "int32",
          "description": "The ID of the account this field value relates to"
        }
      }
    }
  }
}
object FieldBulkUpdateCustomFieldValueRequest 
{
  "type": "object",
  "properties": {
    "array": {
      "type": "object",
      "required": [
        "id",
        "fieldValue"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "ID of the dealCustomFieldData to update"
        },
        "fieldValue": {
          "type": "string",
          "description": "Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)"
        },
        "fieldCurrency": {
          "type": "string",
          "description": "Currency code for the money value"
        }
      }
    }
  }
}
object FieldCreateCustomFieldMetaRequest 
{
  "type": "object",
  "properties": {
    "accountCustomFieldMetum": {
      "type": "object",
      "required": [
        "fieldLabel",
        "fieldType"
      ],
      "properties": {
        "fieldType": {
          "type": "string",
          "description": "Type of field. Possible values are: `text`, `textarea`, `date`, `datetime`, `dropdown`, `multiselect`, `radio`, `checkbox`, `hidden`, `currency`, or `number`."
        },
        "fieldLabel": {
          "type": "string",
          "description": "Name of the field"
        },
        "displayOrder": {
          "type": "integer",
          "format": "int32",
          "description": "Order for displaying the field on Manage Fields page and deal profiles"
        },
        "fieldDefault": {
          "type": "string",
          "description": "Default value of the field"
        },
        "fieldOptions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Options for the field. Only necessary if `field_type` is `dropdown`, `multiselect`, `radio`, or `checkbox`."
        },
        "isFormVisible": {
          "type": "boolean",
          "description": "Whether or not the field is visible on forms"
        },
        "fieldDefaultCurrency": {
          "type": "string",
          "description": "The 3-letter currency code of the default currency for the field. Only necessary if `field_type` is `currency`."
        }
      }
    }
  }
}
object FieldCreateCustomFieldValueRequest 
{
  "type": "object",
  "properties": {
    "accountCustomFieldDatum": {
      "type": "object",
      "required": [
        "customerAccountId",
        "customFieldId",
        "fieldValue"
      ],
      "properties": {
        "fieldValue": {
          "type": "string",
          "description": "Values for the field. (For `currency` field only, this needs to be in cents: eg, 10050 = 100.5)"
        },
        "customFieldId": {
          "type": "integer",
          "format": "int32",
          "description": "The ID of the custom field metum this field value relates to"
        },
        "fieldCurrency": {
          "type": "string",
          "default": "Default Currency for Field",
          "description": "Currency code for the money value"
        },
        "customerAccountId": {
          "type": "integer",
          "format": "int32",
          "description": "The ID of the account this field value relates to"
        }
      }
    }
  }
}
object FieldUpdateCustomFieldMetaRequest 
{
  "type": "object",
  "properties": {
    "accountCustomFieldMetum": {
      "type": "object",
      "required": [],
      "properties": {
        "fieldLabel": {
          "type": "string",
          "description": "Name of the field"
        },
        "displayOrder": {
          "type": "integer",
          "format": "int32",
          "description": "Order for displaying the field on Manage Fields page and deal profiles"
        },
        "fieldDefault": {
          "type": "string",
          "description": "Default value of the field"
        },
        "fieldOptions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Options for the field. Only necessary if field_type is dropdown, multiselect, radio, or checkbox."
        },
        "isFormVisible": {
          "type": "boolean",
          "description": "Whether or not the field is visible on forms"
        }
      }
    }
  }
}
object FieldUpdateCustomFieldValueRequest 
{
  "type": "object",
  "properties": {
    "accountCustomFieldDatum": {
      "type": "object",
      "required": [],
      "properties": {
        "fieldValue": {
          "type": "string",
          "description": "Values for text"
        },
        "fieldCurrency": {
          "type": "string",
          "default": "Default Currency for Field",
          "description": "Currency code for the `currency` value"
        }
      }
    }
  }
}
object MessageCreateNewMessageRequest 
{
  "type": "object",
  "properties": {
    "message": {
      "type": "object",
      "required": [
        "fromname",
        "email",
        "reply2"
      ],
      "properties": {
        "email": {
          "type": "string",
          "description": "Email of sender"
        },
        "reply2": {
          "type": "string",
          "description": "Reply email for the recipient to reply to"
        },
        "subject": {
          "type": "string",
          "description": "Subject of message"
        },
        "fromname": {
          "type": "string",
          "description": "Name of sender"
        },
        "preheader_text": {
          "type": "string",
          "description": "Preheader Text"
        }
      }
    }
  }
}
object NoteCreateAccountNoteRequest 
{
  "type": "object",
  "properties": {
    "note": {
      "type": "object",
      "required": [
        "note"
      ],
      "properties": {
        "note": {
          "type": "string",
          "description": "Account note's content"
        }
      }
    }
  }
}
object NoteUpdateNoteRequest 
{
  "type": "object",
  "properties": {
    "note": {
      "type": "object",
      "required": [
        "note"
      ],
      "properties": {
        "note": {
          "type": "string",
          "description": "Account note's content"
        }
      }
    }
  }
}