Create a import
POST {{baseUrl}}/imports
Enqueues an import - currently only supported for users. Amongst other things, the users import allows associating slack channels (if you have already setup the oauth apps).
Request Body
{"import"=>{"users"=>[{"external_id"=>"<string>", "email"=>"<string>", "first_name"=>"<string>", "last_name"=>"<string>", "custom_attributes"=>{"consequat2"=>-72654764.63879952, "sunt_f"=>"aliqua fugiat consectetur Excepteur"}, "phone_numbers"=>["<string>", "<string>"], "channels"=>{"et0"=>-36386723, "mollitb6d"=>86424176}}, {"external_id"=>"<string>", "email"=>"<string>", "first_name"=>"<string>", "last_name"=>"<string>", "custom_attributes"=>{"esseb7"=>91181740}, "phone_numbers"=>["<string>", "<string>"], "channels"=>{"elit_4"=>false, "velite_e"=>"aliqua fugiat consequat velit"}}]}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-MAGICBELL-API-KEY | string | (Required) The (public) API key of your MagicBell project. | |
X-MAGICBELL-API-SECRET | string | (Required) The API secret of your MagicBell project. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"import":{"id":"\u003cstring\u003e","status":"enqueued","summary":{"total":"\u003cinteger\u003e","failures":"\u003cinteger\u003e"},"errors":[{"email":"\u003cstring\u003e","external_id":"\u003cstring\u003e","message":"\u003cstring\u003e"},{"email":"\u003cstring\u003e","external_id":"\u003cstring\u003e","message":"\u003cstring\u003e"}],"failures":{"users":[{"email":"\u003cstring\u003e","external_id":"\u003cstring\u003e","errors":{}},{"email":"\u003cstring\u003e","external_id":"\u003cstring\u003e","errors":{}}]}}}