campaigns create
POST {{baseUrl}}/campaigns
Creates a Campaign
object with the given values.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
is_debug_mode | boolean | Whether to include debug fields (such as log file links) in the response. | |
run_async | boolean | Whether or not third-party updates should be run asynchronously. |
Request Body
[{"name"=>"name", "value"=>"New Customer Campaign", "datatype"=>"string"}, {"name"=>"unique_opens", "value"=>"806099245", "datatype"=>"number"}, {"name"=>"emails_sent", "value"=>"-247684140", "datatype"=>"number"}, {"name"=>"integration_params", "value"=>"[object Object]", "datatype"=>"string"}, {"name"=>"linked_account_params", "value"=>"[object Object]", "datatype"=>"string"}]
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"errors":[{"detail":"custom_fields is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","title":"Missing Required Field","source":{"pointer":"quis"}},{"detail":"custom_fields is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","title":"Missing Required Field","source":{"pointer":"v"}}],"model":{"name":"New Customer Campaign","unique_opens":-1937168954,"remote_created_at":"2022-12-23T00:00:00Z","emails_sent":-375837566,"id":"urn:uuid:1a0c6220-4461-b631-2a67-18230eac08db","remote_id":"30"},"warnings":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","title":"Unrecognized Field","source":{"pointer":"ea cupidatat dolore"}},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","title":"Unrecognized Field","source":{"pointer":"adipisicin"}}],"logs":[{"dashboard_view":"https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_id":"99433219-8017-4acd-bb3c-ceb23d663832","log_summary":{"method":"POST","status_code":200,"url":"https://harvest.greenhouse.io/v1/candidates/"}},{"dashboard_view":"https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_id":"99433219-8017-4acd-bb3c-ceb23d663832","log_summary":{"method":"POST","status_code":200,"url":"https://harvest.greenhouse.io/v1/candidates/"}}]}